net.sf.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.

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.
ObjectSG	getElement(net.sf.jaxme.xs.xml.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(net.sf.jaxme.xs.xml.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.
net.sf.jaxme.js.JavaSourceFactory	getJavaSourceFactory() Returns the schemas JavaSourceFactory.
net.sf.jaxme.xs.jaxb.JAXBJavaType[]	getJAXBJavaTypes() Returns the globally configured instances of JAXBJavaType.
ObjectSG[]	getObjects() Returns the schemas global attributes and elements.
TypeSG	getType(net.sf.jaxme.xs.xml.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.
net.sf.jaxme.xs.xml.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 net.sf.jaxme.generator.sg.SGItem

getFactory, getLocator, getSchema, init

Method Detail

getTypes

public TypeSG[] getTypes()
                  throws SAXException

Returns the schemas global types.

Throws:

SAXException

getType

public TypeSG getType(net.sf.jaxme.xs.xml.XsQName pName)
               throws SAXException

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

Throws:

SAXException

getGroups

public GroupSG[] getGroups()
                    throws SAXException

Returns the schemas model groups.

Throws:

SAXException

getGroup

public GroupSG getGroup(net.sf.jaxme.xs.xml.XsQName pName)
                 throws SAXException

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

Throws:

SAXException

getObjects

public ObjectSG[] getObjects()
                      throws SAXException

Returns the schemas global attributes and elements.

Throws:

SAXException

getElement

public ObjectSG getElement(net.sf.jaxme.xs.xml.XsQName pName)
                    throws SAXException

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

Throws:

SAXException

getElements

public ObjectSG[] getElements()
                       throws SAXException

Returns the schemas global elements.

Throws:

SAXException

getCollectionType

public java.lang.String getCollectionType()

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

getJavaSourceFactory

public net.sf.jaxme.js.JavaSourceFactory getJavaSourceFactory()

Returns the schemas JavaSourceFactory.

generate

public void generate()
              throws SAXException

Performs the source generation.

Throws:

SAXException

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.

isJavaNamingConventionsEnabled

public boolean isJavaNamingConventionsEnabled()

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

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.

isUnderscoreWordSeparator

public boolean isUnderscoreWordSeparator()

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

getJAXBJavaTypes

public net.sf.jaxme.xs.jaxb.JAXBJavaType[] getJAXBJavaTypes()

Returns the globally configured instances of JAXBJavaType.

getTypesafeEnumBase

public net.sf.jaxme.xs.xml.XsQName[] getTypesafeEnumBase()

Returns the globally configured value for typesafeenumbase.

generateJaxbProperties

public void generateJaxbProperties()
                            throws SAXException

Creates the "jaxb.properties" file.

Throws:

SAXException