org.jibx.binding.generator

Class BindGen

java.lang.Object

org.jibx.binding.generator.BindGen

public class BindGen
extends Object

Binding generator implementation. 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
BindGen(GlobalCustom glob) Create a generator based on a particular set of customizations.

Method Summary

Methods

Modifier and Type	Method and Description
BindingHolder	addBinding(String uri, boolean dflt) Get the binding definition for a namespace, creating a new one if not previously defined.
void	addRootUris(Collection uris) Adds a collection of namespace URIs to be referenced at root binding level.
boolean	checkInclude(String type) Check if a class needs to be included in the binding.
void	defineCollection(String itype, String iname, CollectionElement coll, BindingHolder hold) Define the details of a collection binding.
void	expandReferences(String type, ReferenceCountMap refmap) Expand all references from a class.
BindingHolder	finish(String name) Complete the generated bindings.
void	generate(Boolean abstr, List classes) Generate binding(s) for a list of classes.
void	generateSpecified(ArrayList qnames, List concrs, List abstrs) Generate binding(s) for lists of classes.
BindingHolder	getBinding(String uri) Get the binding definition for a namespace, which must already have been created.
BindingMappingDetail	getMappingDetail(String type) Get the mapping details for a class.
boolean	isValueClass(String type) Check if a class represents a simple value.
static void	main(String[] args) Run the binding generation using command line parameters.
List	validateFiles(File dir, IClassLocator loc, BindingHolder root) Write and validate the generated binding definition files.

Methods inherited from class java.lang.Object

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

Constructor Detail

BindGen

public BindGen(GlobalCustom glob)

Create a generator based on a particular set of customizations.

Parameters:

glob -

Method Detail

isValueClass

public boolean isValueClass(String type)

Check if a class represents a simple value. TODO: implement ClassCustom hooks for this purpose

Parameters:

type - fully qualified class name

Returns:

true if simple value, false if not

checkInclude

public boolean checkInclude(String type)

Check if a class needs to be included in the binding. This checks all members of the class and if necessary superclasses, returning true if any member is ultimately found with a simple value.

Parameters:

type - fully qualified class name

Returns:

true if class to be included in binding, false if it should be skipped

expandReferences

public void expandReferences(String type,
                    ReferenceCountMap refmap)

Expand all references from a class. This checks the types of all members of the class, counting references and calling itself recursively for any types which are not primitives and not java.* or javax.* classes. It also expands the superclass, if specified by the class customizations.

Parameters:

type - fully qualified class name

refmap - reference count map

defineCollection

public void defineCollection(String itype,
                    String iname,
                    CollectionElement coll,
                    BindingHolder hold)

Define the details of a collection binding. Collection bindings may be empty (in the case where the item type is directly mapped), have a <value> child element, or have either a mapping reference or direct definition <structure> child element. This determines the appropriate form based on the item type.

Parameters:

itype - item type

iname - item name

coll -

hold -

generate

public void generate(Boolean abstr,
            List classes)

Generate binding(s) for a list of classes. This creates a <mapping> definition for each class in the list, and either embeds <structure> definitions or creates separate <mapping>s for other classes referenced by these classes. If all the classes use the same namespace only the binding for that namespace will be created; otherwise, a separate binding will be created for each namespace.

Parameters:

abstr - force abstract mapping flag (use both abstract and concrete if null)

classes - class list

generateSpecified

public void generateSpecified(ArrayList qnames,
                     List concrs,
                     List abstrs)

Generate binding(s) for lists of classes. This creates a <mapping> definition for each class in the lists, and either embeds <structure> definitions or creates separate <mapping>s for other classes referenced by these classes. If all the classes use the same namespace only the binding for that namespace will be created; otherwise, a separate binding will be created for each namespace.

Parameters:

qnames - list of names for concrete mappings

concrs - list of classes to be given concrete mappings

abstrs - list of classes to be given abstract mappings

getMappingDetail

public BindingMappingDetail getMappingDetail(String type)

Get the mapping details for a class. This method should only be used after the generate(Boolean, List) method has been called.

Parameters:

type - fully-qualified class name

Returns:

mapping details, or null if none

getBinding

public BindingHolder getBinding(String uri)

Get the binding definition for a namespace, which must already have been created. This method should only be used after the generate(Boolean, List) method has been called. It delegates to the BindingOrganizer implementation.

Parameters:

uri -

Returns:

binding holder

addRootUris

public void addRootUris(Collection uris)

Adds a collection of namespace URIs to be referenced at root binding level.

Parameters:

uris -

addBinding

public BindingHolder addBinding(String uri,
                       boolean dflt)

Get the binding definition for a namespace, creating a new one if not previously defined. This method should only be used after the generate(Boolean, List) method has been called. It delegates to the BindingOrganizer implementation.

Parameters:

uri -

dflt - namespace is default for elements in binding flag

Returns:

binding holder

finish

public BindingHolder finish(String name)

Complete the generated bindings. This prepares the generated bindings for writing to the file system, if desired.

Parameters:

name - file name for root or singleton binding definition

Returns:

holder for root binding definition

validateFiles

public List validateFiles(File dir,
                 IClassLocator loc,
                 BindingHolder root)
                   throws IOException,
                          JiBXException

Write and validate the generated binding definition files.

Parameters:

dir - target directory (bindings not written if null)

loc - class locator for binding validation (ignored if no target directory supplied)

root - holder for root binding definition

Returns:

binding definitions, or null if validation error

Throws:

IOException

JiBXException

main

public static void main(String[] args)
                 throws JiBXException,
                        IOException

Run the binding generation using command line parameters.

Parameters:

args -

Throws:

JiBXException

IOException