org.apache.ws.jaxme.generator.sg
Interface SchemaSG

All Superinterfaces:

SGItem

All Known Implementing Classes:

SchemaSGImpl

public interface SchemaSG
extends SGItem

Interface of a source generator for the whole schema.

Specifies the source representing a complete schema. The actual generation of the concrete source files is delegated to the JavaSourceFactory available by calling getJavaSourceFactory(). Various portions of the source artifacts are made available through property accessors.

Author:

Jochen Wiedmann

Method Summary

void	generate() Performs the source generation.
void	generateJaxbProperties() Creates the "jaxb.properties" file.
java.lang.String	getCollectionType() Returns the schemas collection type, as specified by the JAXB globalBindings tag.
org.w3c.dom.Document	getConfigFile(java.lang.String pPackageName, java.util.List pContextList) Generates the "Configuration.xml" file as a DOM node.
ObjectSG	getElement(XsQName pName) Returns the schemas global element with the given name or null, if no such element exists.
ObjectSG[]	getElements() Returns the schemas global elements.
GroupSG	getGroup(XsQName pName) Returns the schemas global group with the given name or null, if no such type exists.
GroupSG[]	getGroups() Returns the schemas model groups.
JavaSourceFactory	getJavaSourceFactory() Returns the schemas JavaSourceFactory.
JAXBJavaType[]	getJAXBJavaTypes() Returns the globally configured instances of JAXBJavaType.
ObjectSG[]	getObjects() Returns the schemas global attributes and elements.
TypeSG	getType(XsQName pName) Returns the schemas global type with the given name or null, if no such type exists.
TypeSG[]	getTypes() Returns the schemas global types.
XsQName[]	getTypesafeEnumBase() Returns the globally configured value for typesafeenumbase.
boolean	isBindingStyleModelGroup() Returns whether the schema prefers model group binding style or not.
boolean	isChoiceContentProperty() Returns whether the value "choiceContentProperty" is enabled.
boolean	isFailFastCheckEnabled() Returns whether the property "enableFailFastCheck" is enabled.
boolean	isFixedAttributeConstantProperty() Returns whether the property "isFixedAttributeConstantProperty" is enabled.
boolean	isGeneratingIsSetMethod() Returns whether the property "generateIsSetMethod" is enabled.
boolean	isJavaNamingConventionsEnabled() Returns whether the property "enableJavaConventions" is enabled.
boolean	isUnderscoreWordSeparator() Returns whether the property "underscoreBinding" has the value "asWordSeparator".

Methods inherited from interface org.apache.ws.jaxme.generator.sg.SGItem

getFactory, getLocator, getSchema, init

Method Detail

getTypes

TypeSG[] getTypes()
                  throws org.xml.sax.SAXException

Returns the schemas global types.

Throws:

org.xml.sax.SAXException

getType

TypeSG getType(XsQName pName)
               throws org.xml.sax.SAXException

Returns the schemas global type with the given name or null, if no such type exists.

Throws:

org.xml.sax.SAXException

getGroups

GroupSG[] getGroups()
                    throws org.xml.sax.SAXException

Returns the schemas model groups.

Throws:

org.xml.sax.SAXException

getGroup

GroupSG getGroup(XsQName pName)
                 throws org.xml.sax.SAXException

Returns the schemas global group with the given name or null, if no such type exists.

Throws:

org.xml.sax.SAXException

getObjects

ObjectSG[] getObjects()
                      throws org.xml.sax.SAXException

Returns the schemas global attributes and elements.

Throws:

org.xml.sax.SAXException

getElement

ObjectSG getElement(XsQName pName)
                    throws org.xml.sax.SAXException

Returns the schemas global element with the given name or null, if no such element exists.

Throws:

org.xml.sax.SAXException

getElements

ObjectSG[] getElements()
                       throws org.xml.sax.SAXException

Returns the schemas global elements.

Throws:

org.xml.sax.SAXException

getCollectionType

java.lang.String getCollectionType()

Returns the schemas collection type, as specified by the JAXB globalBindings tag.

getJavaSourceFactory

JavaSourceFactory getJavaSourceFactory()

Returns the schemas JavaSourceFactory.

generate

void generate()
              throws org.xml.sax.SAXException

Performs the source generation.

Throws:

org.xml.sax.SAXException

isBindingStyleModelGroup

boolean isBindingStyleModelGroup()

Returns whether the schema prefers model group binding style or not. Defaults to false.

isChoiceContentProperty

boolean isChoiceContentProperty()

Returns whether the value "choiceContentProperty" is enabled. Defaults to false.

isFailFastCheckEnabled

boolean isFailFastCheckEnabled()

Returns whether the property "enableFailFastCheck" is enabled. Defaults to false.

isJavaNamingConventionsEnabled

boolean isJavaNamingConventionsEnabled()

Returns whether the property "enableJavaConventions" is enabled. Defaults to true.

isFixedAttributeConstantProperty

boolean isFixedAttributeConstantProperty()

Returns whether the property "isFixedAttributeConstantProperty" is enabled. Defaults to false.

isGeneratingIsSetMethod

boolean isGeneratingIsSetMethod()

Returns whether the property "generateIsSetMethod" is enabled. Defaults to false.

isUnderscoreWordSeparator

boolean isUnderscoreWordSeparator()

Returns whether the property "underscoreBinding" has the value "asWordSeparator". Defaults to true.

getJAXBJavaTypes

JAXBJavaType[] getJAXBJavaTypes()

Returns the globally configured instances of JAXBJavaType.

getTypesafeEnumBase

XsQName[] getTypesafeEnumBase()

Returns the globally configured value for typesafeenumbase.

getConfigFile

org.w3c.dom.Document getConfigFile(java.lang.String pPackageName,
                                   java.util.List pContextList)
                                   throws org.xml.sax.SAXException

Generates the "Configuration.xml" file as a DOM node. Event handlers may modify the DOM node.

Parameters:

pPackageName - The package, for which a configuration is being generated.

pContextList - A list of objects generated in the package.

Throws:

org.xml.sax.SAXException

generateJaxbProperties

void generateJaxbProperties()
                            throws org.xml.sax.SAXException

Creates the "jaxb.properties" file.

Throws:

org.xml.sax.SAXException