org.apache.ws.jaxme.generator.sg

Interface SchemaSG

All Superinterfaces:
SGItem
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.
String
getCollectionType()
Returns the schemas collection type, as specified by the JAXB globalBindings tag.
Document
getConfigFile(String pPackageName, 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.
JAXBJavaType[]
getJAXBJavaTypes()
Returns the globally configured instances of JAXBJavaType.
JavaSourceFactory
getJavaSourceFactory()
Returns the schemas JavaSourceFactory.
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 Details

generate

public void generate()
            throws SAXException
Performs the source generation.

generateJaxbProperties

public void generateJaxbProperties()
            throws SAXException
Creates the "jaxb.properties" file.

getCollectionType

public String getCollectionType()
Returns the schemas collection type, as specified by the JAXB globalBindings tag.

getConfigFile

public Document getConfigFile(String pPackageName,
                              List pContextList)
            throws 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.

getElement

public ObjectSG getElement(XsQName pName)
            throws SAXException
Returns the schemas global element with the given name or null, if no such element exists.

getElements

public ObjectSG[] getElements()
            throws SAXException
Returns the schemas global elements.

getGroup

public GroupSG getGroup(XsQName pName)
            throws SAXException
Returns the schemas global group with the given name or null, if no such type exists.

getGroups

public GroupSG[] getGroups()
            throws SAXException
Returns the schemas model groups.

getJAXBJavaTypes

public JAXBJavaType[] getJAXBJavaTypes()
Returns the globally configured instances of JAXBJavaType.

getJavaSourceFactory

public JavaSourceFactory getJavaSourceFactory()
Returns the schemas JavaSourceFactory.

getObjects

public ObjectSG[] getObjects()
            throws SAXException
Returns the schemas global attributes and elements.

getType

public TypeSG getType(XsQName pName)
            throws SAXException
Returns the schemas global type with the given name or null, if no such type exists.

getTypes

public TypeSG[] getTypes()
            throws SAXException
Returns the schemas global types.

getTypesafeEnumBase

public XsQName[] getTypesafeEnumBase()
Returns the globally configured value for typesafeenumbase.

isBindingStyleModelGroup

public boolean isBindingStyleModelGroup()
Returns whether the schema prefers model group binding style or not. Defaults to false.

isChoiceContentProperty

public boolean isChoiceContentProperty()
Returns whether the value "choiceContentProperty" is enabled. Defaults to false.

isFailFastCheckEnabled

public boolean isFailFastCheckEnabled()
Returns whether the property "enableFailFastCheck" is enabled. Defaults to false.

isFixedAttributeConstantProperty

public boolean isFixedAttributeConstantProperty()
Returns whether the property "isFixedAttributeConstantProperty" is enabled. Defaults to false.

isGeneratingIsSetMethod

public boolean isGeneratingIsSetMethod()
Returns whether the property "generateIsSetMethod" is enabled. Defaults to false.

isJavaNamingConventionsEnabled

public boolean isJavaNamingConventionsEnabled()
Returns whether the property "enableJavaConventions" is enabled. Defaults to true.

isUnderscoreWordSeparator

public boolean isUnderscoreWordSeparator()
Returns whether the property "underscoreBinding" has the value "asWordSeparator". Defaults to true.