org.jibx.schema.codegen

Class CodeGen

java.lang.Object

org.jibx.schema.codegen.CodeGen

public class CodeGen
extends Object

Code generator from schema definition. Although many of the methods in this class use public access, they are intended for use only by the JiBX developers and may change from one release to the next. To make use of this class from your own code, call the main(String[]) method with an appropriate argument list.

Author:

Dennis M. Sosnoski

Constructor Summary

Constructors

Constructor and Description
CodeGen(SchemasetCustom global, URL root, File target) Constructor.
CodeGen(SchemasetCustom custom, ValidationContext vctx) Constructor used by tests.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyAndNormalize() Apply extensions and normalize all schemas.
String	buildDataModel(boolean verbose, boolean usenns, Map elemmap, Map typemap) Generate the data model.
static boolean	checkNoNamespace(BindingElement binding) Check if a binding definition uses the no-namespace namespace.
boolean	customizeSchemas(String pack, ProblemHandler handler) Validate and apply customizations to loaded schemas.
static List	findPathSteps(File file) Find the steps in the canonical path to a file.
SchemasetCustom	findSchemaset(SchemaElement schema, SchemasetCustom custom) Find the most specific schemaset owning a schema.
boolean	generate(boolean verbose, String usens, String dfltpkg, String bindname, List fileset, List inclpaths, File model, ProblemHandler handler) Generate code from a list of schemas.
BindingOrganizer	getBindingDirectory() Get the binding directory.
PackageOrganizer	getPackageDirectory() Get the package directory used for code generation.
BindingElement	getRootBinding() Get the root binding definition.
ValidationContext	getSchemaValidationContext() Get the validation context used for processing schemas.
static void	main(String[] args) Run the binding generation using command line parameters.
static BindingElement	processPregeneratedBinding(URL url, Map elemmap, Map typemap, ProblemHandler handler) Load and validate binding and process all format and mapping definitions, including those in included bindings.
void	pruneDefinitions() Processes the schemas to remove unused global definitions.
static String	relativeFilePath(File dir, File file) Construct a relative file path.
void	setDefaultPrefixes(Iterator iter) Scan schemas to find the default prefixes used for namespaces.
void	writeBindings(String name, String pack, List pregens, ProblemHandler handler) Write the binding definitions file(s).

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeGen

public CodeGen(SchemasetCustom global,
       URL root,
       File target)

Constructor.

Parameters:

global - schema customization root element

root - URL for base of schema paths

target - destination directory for code generation

CodeGen

public CodeGen(SchemasetCustom custom,
       ValidationContext vctx)

Constructor used by tests. This uses supplied schemas and skips writing to the file system.

Parameters:

custom -

vctx -

Method Detail

getSchemaValidationContext

public ValidationContext getSchemaValidationContext()

Get the validation context used for processing schemas.

Returns:

context

findSchemaset

public SchemasetCustom findSchemaset(SchemaElement schema,
                            SchemasetCustom custom)

Find the most specific schemaset owning a schema. If multiple matches are found which are not in line of containment the first match is returned and the conflict is reported as an error.

Parameters:

schema -

custom - schema set customization

Returns:

owning schemaset, null if none

setDefaultPrefixes

public void setDefaultPrefixes(Iterator iter)

Scan schemas to find the default prefixes used for namespaces.

Parameters:

iter - schema iterator

customizeSchemas

public boolean customizeSchemas(String pack,
                       ProblemHandler handler)

Validate and apply customizations to loaded schemas.

Parameters:

pack - package to be used by default for no-namespaced schemas (non-null)

handler - validation problem handler

Returns:

true if successful, false if error

applyAndNormalize

public void applyAndNormalize()

Apply extensions and normalize all schemas. This may be a multipass process, since applying extensions may create the opportunity for further normalizations and vice versa.

pruneDefinitions

public void pruneDefinitions()

Processes the schemas to remove unused global definitions.

buildDataModel

public String buildDataModel(boolean verbose,
                    boolean usenns,
                    Map elemmap,
                    Map typemap)

Generate the data model. This first builds a representation of all the data items from the schema definitions, then determines which items can be inlined and which need separate class representations, and finally builds the actual data model class and binding definitions.

Parameters:

verbose - verbose output flag

usenns - no-namespace namespace used flag

typemap - map from qualified name of type (or attributeGroup, or group) to pregenerated mapping definition

elemmap - map from qualified name of element to pregenerated mapping definition

Returns:

root package for binding

getBindingDirectory

public BindingOrganizer getBindingDirectory()

Get the binding directory.

Returns:

directory

writeBindings

public void writeBindings(String name,
                 String pack,
                 List pregens,
                 ProblemHandler handler)
                   throws JiBXException,
                          IOException

Write the binding definitions file(s). This method can only be used after buildDataModel(boolean, boolean, Map, Map) is called.

Parameters:

name - root binding definition file name (use customization, or default, if null)

pack - target package for binding (null if unspecified)

pregens - pregenerated bindings to be included in root binding

handler - validation error and code generation problem handler

Throws:

JiBXException

IOException

getRootBinding

public BindingElement getRootBinding()

Get the root binding definition. This is only allowed after the call to writeBindings(String, String, List, ProblemHandler).

Returns:

root binding element

getPackageDirectory

public PackageOrganizer getPackageDirectory()

Get the package directory used for code generation.

Returns:

directory

generate

public boolean generate(boolean verbose,
               String usens,
               String dfltpkg,
               String bindname,
               List fileset,
               List inclpaths,
               File model,
               ProblemHandler handler)
                 throws JiBXException,
                        IOException

Generate code from a list of schemas.

Parameters:

verbose - verbose output flag

usens - namespace to be used when no schemas with namespaces are being generated (null if not specified)

dfltpkg - default package for no-namespace schemas (null if not specified)

bindname - name for root binding (null if not specified)

fileset - list of resolvers for schemas to be generated

inclpaths - list of paths for bindings to be used for matching schema definitions (empty if none)

model - file to be used for dumping generated data model (null if none)

handler - validation error and code generation problem handler

Returns:

true if successful, false if failure

Throws:

JiBXException

IOException

processPregeneratedBinding

public static BindingElement processPregeneratedBinding(URL url,
                                        Map elemmap,
                                        Map typemap,
                                        ProblemHandler handler)
                                                 throws JiBXException,
                                                        IOException

Load and validate binding and process all format and mapping definitions, including those in included bindings.

Parameters:

url - binding definition path

elemmap - map from element qualified name to class data

typemap - map from type qualified name to class data

handler - validation error and problem handler

Returns:

binding

Throws:

JiBXException

IOException

findPathSteps

public static List findPathSteps(File file)
                          throws IOException

Find the steps in the canonical path to a file.

Parameters:

file -

Returns:

steps

Throws:

IOException

relativeFilePath

public static String relativeFilePath(File dir,
                      File file)
                               throws IOException

Construct a relative file path.

Parameters:

dir - start directory for path

file - supplied file path

Returns:

relative file path

Throws:

IOException

checkNoNamespace

public static boolean checkNoNamespace(BindingElement binding)

Check if a binding definition uses the no-namespace namespace. This calls itself to recursively check on included bindings.

Parameters:

binding -

Returns:

true if no-namespace namespace used, false if not

main

public static void main(String[] args)
                 throws Exception

Run the binding generation using command line parameters.

Parameters:

args -

Throws:

Exception