Package org.jibx.schema.generator
Class SchemaGen
java.lang.Object
org.jibx.schema.generator.SchemaGen
Schema generator from binding 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
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final Map
Map from fully-qualified class name to qualified simple type name.private final ValidationContext
Validation context for bindings.private final GlobalCustom
Binding customization information.private final DetailDirectory
Details for mappings and enum usages.private final FormatterCache
JavaDoc formatter instance cache.private final IClassLocator
Locator for class information (null
if none).private final Map
Map from namespace to schema file name.private final Map
Map from namespace to schema holder. -
Constructor Summary
ConstructorsConstructorDescriptionSchemaGen
(IClassLocator loc, GlobalCustom custom, Map urinames) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionprivate static void
Add a compositor as a particle in another compositor.private void
addDocumentation
(IClass info, AnnotatedBase root) Add class-level documentation to a schema component.private void
addItemDocumentation
(StructureElementBase struct, AnnotatedBase elem) Add documentation for a particular field or property.private void
addItemDocumentation
(ValueElement value, AnnotatedBase elem) Add documentation for a particular field or property.private void
addMapping
(MappingDetail detail) Add mapping to schema definitions.private ComplexTypeElement
buildComplexType
(MappingDetail detail, SchemaHolder hold) Build the complex type definition for a mapping.private CommonCompositorDefinition
buildCompositor
(ContainerElementBase cont, int offset, boolean repeat, SchemaHolder hold) Build compositor for type definition.private ElementElement
buildElement
(IComponent comp, boolean repeat, SchemaHolder hold) Build a schema element description from a binding content component.buildSchemas
(List bindings) Generate a list of schemas from a list of bindings.private SimpleTypeElement
buildSimpleType
(IComponent comp) Convenience method to create the simple type definition for the type of a component.private SimpleTypeElement
buildSimpleType
(IClass type) Create the simple type definition for a type.private void
checkDependency
(QName qname, SchemaHolder hold) Check for dependency on another schema.private void
fillAttributes
(ContainerElementBase cont, int offset, AbstractList attrs, SchemaHolder hold) Build attributes as part of complex type definition.findSchema
(String uri) Find the schema to be used for a particular namespace.finishSchemas
(Collection exists) Finish the construction of schemas, setting links between the schemas and validating the schemas.Generate a list of schemas from a list of bindings.Get details of schema handling of a mapping.private QName
getSimpleTypeQName
(IComponent comp) Get the qualified name of the simple type used for a component, if a named simple type.private static boolean
Check if a container element of the binding represents complex content.private static boolean
isDifferentSchema
(QName qname, SchemaHolder hold) Check if a name references a different schema.private static boolean
General object comparison method.static void
Run the schema generation using command line parameters.private void
setAttributeType
(QName qname, AttributeElement elem, SchemaHolder hold) Set attribute type, adding schema reference if necessary.private void
setComplexExtensionBase
(QName qname, ComplexExtensionElement ext, SchemaHolder hold) Set the base for a complex extension type.private void
setDocumentation
(IClassItem item, AnnotatedBase elem) Set the documentation for a schema component matching a class member.private void
setElementRef
(QName qname, ElementElement elem, SchemaHolder hold) Set element reference, adding schema reference if necessary.void
setElementType
(QName qname, ElementElement elem, SchemaHolder hold) Set element type, adding schema reference if necessary.private void
setGroupRef
(QName qname, AttributeGroupRefElement group, SchemaHolder hold) Set group reference, adding schema reference if necessary.private void
setGroupRef
(QName qname, GroupRefElement group, SchemaHolder hold) Set group reference, adding schema reference if necessary.private void
setSimpleExtensionBase
(QName qname, SimpleExtensionElement ext, SchemaHolder hold) Set the base for a simple extension type.private void
setSubstitutionGroup
(QName qname, ElementElement elem, SchemaHolder hold) Set element substitution group, adding schema reference if necessary.static void
writeSchemas
(File dir, Collection schemas) Write a collection of schemas to a target directory.
-
Field Details
-
m_locator
Locator for class information (null
if none). -
m_custom
Binding customization information. -
m_classSimpletypes
Map from fully-qualified class name to qualified simple type name. -
m_uriNames
Map from namespace to schema file name. -
m_uriSchemas
Map from namespace to schema holder. -
m_formatCache
JavaDoc formatter instance cache. -
m_context
Validation context for bindings. -
m_detailDirectory
Details for mappings and enum usages.
-
-
Constructor Details
-
SchemaGen
Constructor.- Parameters:
loc
- locator for class information (null
if none)custom
- binding customization information (used for creating names as needed)urinames
- map from namespace URI to schema file name
-
-
Method Details
-
findSchema
Find the schema to be used for a particular namespace. If this is the first time a particular namespace was requested, a new schema will be created for that namespace and returned.- Parameters:
uri
- namespace URI (null
if no namespace)- Returns:
- schema holder
-
getSimpleTypeQName
Get the qualified name of the simple type used for a component, if a named simple type. If this returnsnull
, thebuildSimpleType(IComponent)
method needs to be able to construct the appropriate simple type definition.- Parameters:
comp
-- Returns:
- qualified type name,
null
if inline definition needed
-
addDocumentation
Add class-level documentation to a schema component.- Parameters:
info
- class information (null
if not available)root
-
-
setDocumentation
Set the documentation for a schema component matching a class member.- Parameters:
item
-elem
-
-
addItemDocumentation
Add documentation for a particular field or property.- Parameters:
struct
-elem
-
-
addItemDocumentation
Add documentation for a particular field or property.- Parameters:
value
-elem
-
-
buildSimpleType
Create the simple type definition for a type. This is only used for cases wheregetSimpleTypeQName(IComponent)
returnsnull
. The current implementation only supports Java 5 Enum types, but in the future should be extended to support <format>-type conversions with supplied schema definitions. This code requires a Java 5+ JVM to execute, but uses reflection to allow this class to be loaded on older JVMs.- Parameters:
type
-- Returns:
- type definition
-
buildSimpleType
Convenience method to create the simple type definition for the type of a component.- Parameters:
comp
-- Returns:
- type definition
-
isEqual
General object comparison method. Don't know why Sun hasn't seen fit to include this somewhere, but at least it's easy to write (over and over again).- Parameters:
a
- first object to be comparedb
- second object to be compared- Returns:
true
if both objects arenull
, or ifa.equals(b)
;false
otherwise
-
isDifferentSchema
Check if a name references a different schema.- Parameters:
qname
- name to be checkedhold
- schema holder- Returns:
true
if different,false
if the same
-
checkDependency
Check for dependency on another schema. This creates an import for the target schema, and assigns a prefix for referencing the target schema namespace.- Parameters:
qname
- name referenced by this schemahold
- schema holder
-
buildElement
Build a schema element description from a binding content component.- Parameters:
comp
- source componentrepeat
- repeated element flaghold
-- Returns:
- element
-
addCompositorPart
private static void addCompositorPart(CommonCompositorDefinition part, CommonCompositorDefinition comp) Add a compositor as a particle in another compositor. If the compositor being added has only one particle, the particle is directly added to the containing compositor.- Parameters:
part
- compositor being added as a particlecomp
- target compositor for add
-
buildCompositor
private CommonCompositorDefinition buildCompositor(ContainerElementBase cont, int offset, boolean repeat, SchemaHolder hold) Build compositor for type definition. This creates and returns the appropriate form of compositor for the container, populated with particles matching the child element components of the binding container.- Parameters:
cont
- container element defining structureoffset
- offset for first child component to processrepeat
- repeated item flaghold
- holder for schema under construction- Returns:
- constructed compositor
-
setGroupRef
Set group reference, adding schema reference if necessary.- Parameters:
qname
- reference namegroup
-hold
- schema holder
-
setGroupRef
Set group reference, adding schema reference if necessary.- Parameters:
qname
- reference namegroup
-hold
- schema holder
-
setElementRef
Set element reference, adding schema reference if necessary.- Parameters:
qname
- reference nameelem
-hold
- schema holder
-
setAttributeType
Set attribute type, adding schema reference if necessary.- Parameters:
qname
- type nameelem
-hold
- schema holder
-
setElementType
Set element type, adding schema reference if necessary.- Parameters:
qname
- type nameelem
-hold
- schema holder
-
setSubstitutionGroup
Set element substitution group, adding schema reference if necessary.- Parameters:
qname
- substitution group element nameelem
-hold
- schema holder
-
fillAttributes
private void fillAttributes(ContainerElementBase cont, int offset, AbstractList attrs, SchemaHolder hold) Build attributes as part of complex type definition.- Parameters:
cont
- container element defining structureoffset
- offset for first child component to processattrs
- complex type attribute listhold
- holder for schema under construction
-
isComplexContent
Check if a container element of the binding represents complex content.- Parameters:
cont
-- Returns:
true
if complex content,false
if not
-
buildComplexType
Build the complex type definition for a mapping.- Parameters:
detail
- mapping detailhold
- target schema for definition- Returns:
- constructed complex type
-
setComplexExtensionBase
Set the base for a complex extension type.- Parameters:
qname
-ext
-hold
-
-
setSimpleExtensionBase
Set the base for a simple extension type.- Parameters:
qname
-ext
-hold
-
-
addMapping
Add mapping to schema definitions. This generates the appropriate schema representation for the mapping based on the detail flags, which may include group and/or attributeGroup, complexType, and element definitions.- Parameters:
detail
-
-
buildSchemas
Generate a list of schemas from a list of bindings. The two lists are not necessarily in any particular relationship to each other.- Parameters:
bindings
- list ofBindingElement
- Returns:
- list of
SchemaHolder
-
finishSchemas
Finish the construction of schemas, setting links between the schemas and validating the schemas.- Parameters:
exists
- existing schemas potentially referenced (by name, rather than id) from constructed schemas- Returns:
- list of
SchemaHolder
-
generate
Generate a list of schemas from a list of bindings. The two lists are not necessarily in any particular relationship to each other. This method is provided for backward compatibility; it just combines a call tobuildSchemas(List)
with a call tofinishSchemas(Collection)
with an empty list of existing schemas.- Parameters:
bindings
- list ofBindingElement
- Returns:
- list of
SchemaHolder
-
getMappingDetail
Get details of schema handling of a mapping.- Parameters:
map
-- Returns:
- mapping details
-
writeSchemas
Write a collection of schemas to a target directory.- Parameters:
dir
- target directoryschemas
- list ofSchemaHolder
- Throws:
JiBXException
IOException
-
main
Run the schema generation using command line parameters.- Parameters:
args
-- Throws:
JiBXException
IOException
-