ch.rasc.extclassgenerator

Class ModelGenerator

java.lang.Object

ch.rasc.extclassgenerator.ModelGenerator

public abstract class ModelGenerator
extends Object

Generator for creating ExtJS and Touch Model objects (JS code) based on a provided class or ModelBean.

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	UTF8_CHARSET

Constructor Summary

Constructors

Constructor and Description
ModelGenerator()

Method Summary

Modifier and Type	Method and Description
static void	clearCaches() Clears the model and Javascript code caches
static ModelBean	createModel(Class<?> clazz) Instrospects the provided class and creates a ModelBean instance.
static ModelBean	createModel(Class<?> clazz, IncludeValidation includeValidation) Instrospects the provided class and creates a ModelBean instance.
static ModelBean	createModel(Class<?> clazz, OutputConfig outputConfig)
static String	generateJavascript(Class<?> clazz, OutputConfig outputConfig)
static String	generateJavascript(Class<?> clazz, OutputFormat format, boolean debug) Instrospects the provided class, creates a model object (JS code) and returns it.
static String	generateJavascript(Class<?> clazz, OutputFormat format, IncludeValidation includeValidation, boolean debug) Instrospects the provided class, creates a model object (JS code) and returns it.
static String	generateJavascript(ModelBean model, OutputConfig outputConfig)
static String	generateJavascript(ModelBean model, OutputFormat format, boolean debug) Creates JS code based on the provided ModelBean in the specified OutputFormat.
static void	writeModel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Class<?> clazz, OutputConfig outputConfig)
static void	writeModel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Class<?> clazz, OutputFormat format) Instrospects the provided class, creates a model object (JS code) and writes it into the response.
static void	writeModel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Class<?> clazz, OutputFormat format, boolean debug) Instrospects the provided class, creates a model object (JS code) and writes it into the response.
static void	writeModel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Class<?> clazz, OutputFormat format, IncludeValidation includeValidation, boolean debug) Instrospects the provided class, creates a model object (JS code) and writes it into the response.
static void	writeModel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, ModelBean model, OutputConfig outputConfig)
static void	writeModel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, ModelBean model, OutputFormat format) Creates a model object (JS code) based on the provided ModelBean and writes it into the response.
static void	writeModel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, ModelBean model, OutputFormat format, boolean debug) Creates a model object (JS code) based on the provided ModelBean and writes it into the response.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

UTF8_CHARSET

public static final Charset UTF8_CHARSET

Constructor Detail

ModelGenerator

public ModelGenerator()

Method Detail

writeModel

public static void writeModel(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response,
                              Class<?> clazz,
                              OutputFormat format)
                       throws IOException

Instrospects the provided class, creates a model object (JS code) and writes it into the response. Creates compressed JS code. Method ignores any validation annotations.

Parameters:

request - the http servlet request

response - the http servlet response

clazz - class that the generator should introspect

format - specifies which code (ExtJS or Touch) the generator should create.

Throws:

IOException

See Also:

writeModel(HttpServletRequest, HttpServletResponse, Class, OutputFormat, boolean)

writeModel

public static void writeModel(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response,
                              Class<?> clazz,
                              OutputFormat format,
                              boolean debug)
                       throws IOException

Instrospects the provided class, creates a model object (JS code) and writes it into the response. Method ignores any validation annotations.

Parameters:

request - the http servlet request

response - the http servlet response

clazz - class that the generator should introspect

format - specifies which code (ExtJS or Touch) the generator should create

debug - if true the generator creates the output in pretty format, false the output is compressed

Throws:

IOException

writeModel

public static void writeModel(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response,
                              Class<?> clazz,
                              OutputFormat format,
                              IncludeValidation includeValidation,
                              boolean debug)
                       throws IOException

Instrospects the provided class, creates a model object (JS code) and writes it into the response.

Parameters:

request - the http servlet request

response - the http servlet response

clazz - class that the generator should introspect

format - specifies which code (ExtJS or Touch) the generator should create

includeValidation - specifies if any validation configurations should be added to the model code

debug - if true the generator creates the output in pretty format, false the output is compressed

Throws:

IOException

writeModel

public static void writeModel(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response,
                              Class<?> clazz,
                              OutputConfig outputConfig)
                       throws IOException

Throws:

IOException

writeModel

public static void writeModel(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response,
                              ModelBean model,
                              OutputFormat format)
                       throws IOException

Creates a model object (JS code) based on the provided ModelBean and writes it into the response. Creates compressed JS code.

Parameters:

request - the http servlet request

response - the http servlet response

model - ModelBean describing the model to be generated

format - specifies which code (ExtJS or Touch) the generator should create.

Throws:

IOException

writeModel

public static void writeModel(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response,
                              ModelBean model,
                              OutputFormat format,
                              boolean debug)
                       throws IOException

Creates a model object (JS code) based on the provided ModelBean and writes it into the response.

Parameters:

request - the http servlet request

response - the http servlet response

model - ModelBean describing the model to be generated

format - specifies which code (ExtJS or Touch) the generator should create.

debug - if true the generator creates the output in pretty format, false the output is compressed

Throws:

IOException

createModel

public static ModelBean createModel(Class<?> clazz)

Instrospects the provided class and creates a ModelBean instance. A program could customize this and call generateJavascript(ModelBean, OutputFormat, boolean) or writeModel(HttpServletRequest, HttpServletResponse, ModelBean, OutputFormat) to create the JS code. Calling this method does not add any validation configuration.

Parameters:

clazz - the model will be created based on this class.

Returns:

a instance of ModelBean that describes the provided class and can be used for Javascript generation.

createModel

public static ModelBean createModel(Class<?> clazz,
                                    IncludeValidation includeValidation)

Instrospects the provided class and creates a ModelBean instance. A program could customize this and call generateJavascript(ModelBean, OutputFormat, boolean) or writeModel(HttpServletRequest, HttpServletResponse, ModelBean, OutputFormat) to create the JS code. Models are being cached. A second call with the same parameters will return the model from the cache.

Parameters:

clazz - the model will be created based on this class.

includeValidation - specifies what validation configuration should be added

Returns:

a instance of ModelBean that describes the provided class and can be used for Javascript generation.

generateJavascript

public static String generateJavascript(Class<?> clazz,
                                        OutputFormat format,
                                        boolean debug)

Instrospects the provided class, creates a model object (JS code) and returns it. This method does not add any validation configuration.

Parameters:

clazz - class that the generator should introspect

format - specifies which code (ExtJS or Touch) the generator should create

debug - if true the generator creates the output in pretty format, false the output is compressed

Returns:

the generated model object (JS code)

generateJavascript

public static String generateJavascript(Class<?> clazz,
                                        OutputConfig outputConfig)

generateJavascript

public static String generateJavascript(Class<?> clazz,
                                        OutputFormat format,
                                        IncludeValidation includeValidation,
                                        boolean debug)

Instrospects the provided class, creates a model object (JS code) and returns it.

Parameters:

clazz - class that the generator should introspect

format - specifies which code (ExtJS or Touch) the generator should create

includeValidation - specifies what validation configuration should be added to the mode code

debug - if true the generator creates the output in pretty format, false the output is compressed

Returns:

the generated model object (JS code)

generateJavascript

public static String generateJavascript(ModelBean model,
                                        OutputFormat format,
                                        boolean debug)

Creates JS code based on the provided ModelBean in the specified OutputFormat. Code can be generated in pretty or compressed format. The generated code is cached unless debug is true. A second call to this method with the same model name and format will return the code from the cache.

Parameters:

model - generate code based on this ModelBean

format - specifies which code (ExtJS or Touch) the generator should create

debug - if true the generator creates the output in pretty format, false the output is compressed

Returns:

the generated model object (JS code)

writeModel

public static void writeModel(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response,
                              ModelBean model,
                              OutputConfig outputConfig)
                       throws IOException

Throws:

IOException

createModel

public static ModelBean createModel(Class<?> clazz,
                                    OutputConfig outputConfig)

generateJavascript

public static String generateJavascript(ModelBean model,
                                        OutputConfig outputConfig)

clearCaches

public static void clearCaches()

Clears the model and Javascript code caches