Field Detail

• m_locator

  private final IClassLocator m_locator

  Locator for class information (null if none).

• m_custom

  private final GlobalCustom m_custom

  Binding customization information.

• m_classSimpletypes

  private final java.util.Map m_classSimpletypes

  Map from fully-qualified class name to qualified simple type name.

• m_uriNames

  private final java.util.Map m_uriNames

  Map from namespace to schema file name.

• m_uriSchemas

  private final java.util.Map m_uriSchemas

  Map from namespace to schema holder.

• m_formatCache

  private final FormatterCache m_formatCache

  JavaDoc formatter instance cache.

• m_context

  private final ValidationContext m_context

  Validation context for bindings.

• m_detailDirectory

  private final DetailDirectory m_detailDirectory

  Details for mappings and enum usages.

Constructor Detail

• SchemaGen

  public SchemaGen​(IClassLocator loc,
                   GlobalCustom custom,
                   java.util.Map urinames)

  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 Detail

• findSchema

  public SchemaHolder findSchema​(java.lang.String uri)

  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

  private QName getSimpleTypeQName​(IComponent comp)

  Get the qualified name of the simple type used for a component, if a named simple type. If this returns null, the buildSimpleType(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

  private void addDocumentation​(IClass info,
                                AnnotatedBase root)

  Add class-level documentation to a schema component.

  Parameters:

  info - class information (null if not available)

  root -

• setDocumentation

  private void setDocumentation​(IClassItem item,
                                AnnotatedBase elem)

  Set the documentation for a schema component matching a class member.

  Parameters:

  item -

  elem -

• addItemDocumentation

  private void addItemDocumentation​(StructureElementBase struct,
                                    AnnotatedBase elem)

  Add documentation for a particular field or property.

  Parameters:

  struct -

  elem -

• addItemDocumentation

  private void addItemDocumentation​(ValueElement value,
                                    AnnotatedBase elem)

  Add documentation for a particular field or property.

  Parameters:

  value -

  elem -

• buildSimpleType

  private SimpleTypeElement buildSimpleType​(IClass type)

  Create the simple type definition for a type. This is only used for cases where getSimpleTypeQName(IComponent) returns null. 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

  private SimpleTypeElement buildSimpleType​(IComponent comp)

  Convenience method to create the simple type definition for the type of a component.

  Parameters:

  comp -

  Returns:

  type definition

• isEqual

  private static boolean isEqual​(java.lang.Object a,
                                 java.lang.Object b)

  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 compared

  b - second object to be compared

  Returns:

  true if both objects are null, or if a.equals(b); false otherwise

• isDifferentSchema

  private static boolean isDifferentSchema​(QName qname,
                                           SchemaHolder hold)

  Check if a name references a different schema.

  Parameters:

  qname - name to be checked

  hold - schema holder

  Returns:

  true if different, false if the same

• checkDependency

  private void checkDependency​(QName qname,
                               SchemaHolder hold)

  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 schema

  hold - schema holder

• buildElement

  private ElementElement buildElement​(IComponent comp,
                                      boolean repeat,
                                      SchemaHolder hold)

  Build a schema element description from a binding content component.

  Parameters:

  comp - source component

  repeat - repeated element flag

  hold -

  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 particle

  comp - 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 structure

  offset - offset for first child component to process

  repeat - repeated item flag

  hold - holder for schema under construction

  Returns:

  constructed compositor

• setGroupRef

  private void setGroupRef​(QName qname,
                           AttributeGroupRefElement group,
                           SchemaHolder hold)

  Set group reference, adding schema reference if necessary.

  Parameters:

  qname - reference name

  group -

  hold - schema holder

• setGroupRef

  private void setGroupRef​(QName qname,
                           GroupRefElement group,
                           SchemaHolder hold)

  Set group reference, adding schema reference if necessary.

  Parameters:

  qname - reference name

  group -

  hold - schema holder

• setElementRef

  private void setElementRef​(QName qname,
                             ElementElement elem,
                             SchemaHolder hold)

  Set element reference, adding schema reference if necessary.

  Parameters:

  qname - reference name

  elem -

  hold - schema holder

• setAttributeType

  private void setAttributeType​(QName qname,
                                AttributeElement elem,
                                SchemaHolder hold)

  Set attribute type, adding schema reference if necessary.

  Parameters:

  qname - type name

  elem -

  hold - schema holder

• setElementType

  public void setElementType​(QName qname,
                             ElementElement elem,
                             SchemaHolder hold)

  Set element type, adding schema reference if necessary.

  Parameters:

  qname - type name

  elem -

  hold - schema holder

• setSubstitutionGroup

  private void setSubstitutionGroup​(QName qname,
                                    ElementElement elem,
                                    SchemaHolder hold)

  Set element substitution group, adding schema reference if necessary.

  Parameters:

  qname - substitution group element name

  elem -

  hold - schema holder

• fillAttributes

  private void fillAttributes​(ContainerElementBase cont,
                              int offset,
                              java.util.AbstractList attrs,
                              SchemaHolder hold)

  Build attributes as part of complex type definition.

  Parameters:

  cont - container element defining structure

  offset - offset for first child component to process

  attrs - complex type attribute list

  hold - holder for schema under construction

• isComplexContent

  private static boolean isComplexContent​(ContainerElementBase cont)

  Check if a container element of the binding represents complex content.

  Parameters:

  cont -

  Returns:

  true if complex content, false if not

• buildComplexType

  private ComplexTypeElement buildComplexType​(MappingDetail detail,
                                              SchemaHolder hold)

  Build the complex type definition for a mapping.

  Parameters:

  detail - mapping detail

  hold - target schema for definition

  Returns:

  constructed complex type

• setComplexExtensionBase

  private void setComplexExtensionBase​(QName qname,
                                       ComplexExtensionElement ext,
                                       SchemaHolder hold)

  Set the base for a complex extension type.

  Parameters:

  qname -

  ext -

  hold -

• setSimpleExtensionBase

  private void setSimpleExtensionBase​(QName qname,
                                      SimpleExtensionElement ext,
                                      SchemaHolder hold)

  Set the base for a simple extension type.

  Parameters:

  qname -

  ext -

  hold -

• addMapping

  private void addMapping​(MappingDetail detail)

  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

  public java.util.ArrayList buildSchemas​(java.util.List bindings)

  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 of BindingElement

  Returns:

  list of SchemaHolder

• finishSchemas

  public java.util.ArrayList finishSchemas​(java.util.Collection exists)

  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

  public java.util.List generate​(java.util.List bindings)

  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 to buildSchemas(List) with a call to finishSchemas(Collection) with an empty list of existing schemas.

  Parameters:

  bindings - list of BindingElement

  Returns:

  list of SchemaHolder

• getMappingDetail

  public MappingDetail getMappingDetail​(MappingElement map)

  Get details of schema handling of a mapping.

  Parameters:

  map -

  Returns:

  mapping details

• writeSchemas

  public static void writeSchemas​(java.io.File dir,
                                  java.util.Collection schemas)
                           throws JiBXException,
                                  java.io.IOException

  Write a collection of schemas to a target directory.

  Parameters:

  dir - target directory

  schemas - list of SchemaHolder

  Throws:

  JiBXException

  java.io.IOException

• main

  public static void main​(java.lang.String[] args)
                   throws JiBXException,
                          java.io.IOException

  Run the schema generation using command line parameters.

  Parameters:

  args -

  Throws:

  JiBXException

  java.io.IOException