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

All Known Implementing Classes:
SGFactoryImpl

public interface SGFactory

Interface of a factory for SG classes.

Author:
Jochen Wiedmann

Method Summary
 Generator getGenerator()
          Returns the Generator.
 GroupSG[] getGroups()
          Returns an array of all groups created by the factory.
 GroupSG getGroupSG(XSGroup pGroup)
          Returns an instance of GroupSG generating the given schema.
 GroupSG getGroupSG(XSGroup pGroup, Context pClassContext)
          Returns an instance of GroupSG, which is embedded into the given Context.
 ObjectSG[] getObjects()
          Returns an array of all objects created by the factory.
 ObjectSG getObjectSG(XSAny pWildcard, Context pContext)
          Returns an instance of ObjectSG generating the given wildcard in the given context.
 ObjectSG getObjectSG(XSElement pElement)
          Returns an instance of ObjectSG generating the given element.
 ObjectSG getObjectSG(XSElement pElement, Context pContext)
          Returns an instance of ObjectSG generating the given element in the given context.
 SchemaSG getSchemaSG()
          Returns the factorys instance of SchemaSG.
 SchemaSG getSchemaSG(XSSchema pSchema)
          Returns an instance of SchemaSG generating the given schema.
 TypeSG[] getTypes()
          Returns an array of all types created by the factory.
 TypeSG getTypeSG(XSType pType, Context pClassContext, XsQName pName, JAXBProperty.BaseType pBaseType)
          Returns a local instance of TypeSG generating the given type within the given Context.
 TypeSG getTypeSG(XSType pType, JAXBProperty.BaseType pBaseType)
          Returns a global instance of TypeSG generating the given type.
 TypeSG getTypeSG(XSType pType, XsQName pName, JAXBProperty.BaseType pBaseType)
          Returns a new instance of TypeSG generating the given type, as if it were a global type with the given name.
 void init()
          Initializes the SGFactory.
 Facet newFacet(XSType pType, XSEnumeration[] pEnumerations)
          Creates a new enumeration facet.
 GroupSG newGroupSG(XSGroup pGroup)
          Creates a new instance of GroupSG generating the given schema.
 GroupSG newGroupSG(XSGroup pGroup, Context pClassContext)
          Creates a new instance of GroupSG, which is embedded into the given Context.
 java.lang.Object newObjectSG(XSAny any)
          Creates a new instance of ObjectSG generating the given wildcard in the given context.
 java.lang.Object newObjectSG(XSElement pElement)
          Creates a new instance of ObjectSG generating the given element.
 java.lang.Object newObjectSG(XSElement pElement, Context pContext)
          Creates a new instance of ObjectSG generating the given element in the given context.
 java.lang.Object newSchemaSG(XSSchema pSchema)
          Creates a new instance of SchemaSG generating the given schema.
 java.lang.Object newTypeSG(XSType pType, Context pClassContext, XsQName pName, JAXBProperty.BaseType pBaseType)
          Creates a new, local instance of TypeSGChain, generating the given type within the given Context.
 java.lang.Object newTypeSG(XSType pType, JAXBProperty.BaseType pBaseType)
          Creates a new, global instance of TypeSGChain generating the given type.
 java.lang.Object newTypeSG(XSType pType, XsQName pName, JAXBProperty.BaseType pBaseType)
          Creates a new, local instance of TypeSGChain, as if it were a global type with the given name.
 XsObjectFactory newXsObjectFactory()
          Creates a new instance of XsObjectFactory, used by the parser.
 XSObjectFactory newXSObjectFactory()
          Creates a new instance of XSObjectFactory, used by the parser.
 XSParser newXSParser()
          Creates a new instance of XSParser.
 

Method Detail

getGenerator

Generator getGenerator()

Returns the Generator.


init

void init()

Initializes the SGFactory.


newXsObjectFactory

XsObjectFactory newXsObjectFactory()
                                   throws org.xml.sax.SAXException

Creates a new instance of XsObjectFactory, used by the parser.

Throws:
org.xml.sax.SAXException

newXSObjectFactory

XSObjectFactory newXSObjectFactory()
                                   throws org.xml.sax.SAXException

Creates a new instance of XSObjectFactory, used by the parser.

Throws:
org.xml.sax.SAXException

newSchemaSG

java.lang.Object newSchemaSG(XSSchema pSchema)
                             throws org.xml.sax.SAXException

Creates a new instance of SchemaSG generating the given schema.

Throws:
org.xml.sax.SAXException

getSchemaSG

SchemaSG getSchemaSG(XSSchema pSchema)
                     throws org.xml.sax.SAXException

Returns an instance of SchemaSG generating the given schema.

Throws:
org.xml.sax.SAXException

getSchemaSG

SchemaSG getSchemaSG()

Returns the factorys instance of SchemaSG.

Throws:
java.lang.IllegalStateException - The factory has not yet created an instance of SchemaSG. In other words, the methods newSchemaSG(XSSchema) and getSchemaSG(XSSchema) have not yet been invoked.

newObjectSG

java.lang.Object newObjectSG(XSElement pElement)
                             throws org.xml.sax.SAXException

Creates a new instance of ObjectSG generating the given element.

Throws:
org.xml.sax.SAXException

getObjectSG

ObjectSG getObjectSG(XSElement pElement)
                     throws org.xml.sax.SAXException

Returns an instance of ObjectSG generating the given element.

Throws:
org.xml.sax.SAXException

newObjectSG

java.lang.Object newObjectSG(XSElement pElement,
                             Context pContext)
                             throws org.xml.sax.SAXException

Creates a new instance of ObjectSG generating the given element in the given context.

Throws:
org.xml.sax.SAXException

getObjectSG

ObjectSG getObjectSG(XSElement pElement,
                     Context pContext)
                     throws org.xml.sax.SAXException

Returns an instance of ObjectSG generating the given element in the given context.

Throws:
org.xml.sax.SAXException

newObjectSG

java.lang.Object newObjectSG(XSAny any)

Creates a new instance of ObjectSG generating the given wildcard in the given context.


getObjectSG

ObjectSG getObjectSG(XSAny pWildcard,
                     Context pContext)
                     throws org.xml.sax.SAXException

Returns an instance of ObjectSG generating the given wildcard in the given context.

Throws:
org.xml.sax.SAXException

newGroupSG

GroupSG newGroupSG(XSGroup pGroup)
                   throws org.xml.sax.SAXException

Creates a new instance of GroupSG generating the given schema.

Throws:
org.xml.sax.SAXException

getGroupSG

GroupSG getGroupSG(XSGroup pGroup)
                   throws org.xml.sax.SAXException

Returns an instance of GroupSG generating the given schema.

Throws:
org.xml.sax.SAXException

newGroupSG

GroupSG newGroupSG(XSGroup pGroup,
                   Context pClassContext)
                   throws org.xml.sax.SAXException

Creates a new instance of GroupSG, which is embedded into the given Context.

Throws:
org.xml.sax.SAXException

getGroupSG

GroupSG getGroupSG(XSGroup pGroup,
                   Context pClassContext)
                   throws org.xml.sax.SAXException

Returns an instance of GroupSG, which is embedded into the given Context.

Throws:
org.xml.sax.SAXException

newTypeSG

java.lang.Object newTypeSG(XSType pType,
                           JAXBProperty.BaseType pBaseType)
                           throws org.xml.sax.SAXException

Creates a new, global instance of TypeSGChain generating the given type.

Implementation note: The type TypeSGChain must not be exposed in the interface, because the interface class is used to generate this type. In other words, this interface must be compilable without the TypeSGChain interface.

Throws:
org.xml.sax.SAXException

getTypeSG

TypeSG getTypeSG(XSType pType,
                 JAXBProperty.BaseType pBaseType)
                 throws org.xml.sax.SAXException

Returns a global instance of TypeSG generating the given type.

Throws:
org.xml.sax.SAXException

newTypeSG

java.lang.Object newTypeSG(XSType pType,
                           Context pClassContext,
                           XsQName pName,
                           JAXBProperty.BaseType pBaseType)
                           throws org.xml.sax.SAXException

Creates a new, local instance of TypeSGChain, generating the given type within the given Context.

Implementation note: The type TypeSGChain must not be exposed in the interface, because the interface class is used to generate this type. In other words, this interface must be compilable without the TypeSGChain interface.

Throws:
org.xml.sax.SAXException

getTypeSG

TypeSG getTypeSG(XSType pType,
                 Context pClassContext,
                 XsQName pName,
                 JAXBProperty.BaseType pBaseType)
                 throws org.xml.sax.SAXException

Returns a local instance of TypeSG generating the given type within the given Context.

Throws:
org.xml.sax.SAXException

newTypeSG

java.lang.Object newTypeSG(XSType pType,
                           XsQName pName,
                           JAXBProperty.BaseType pBaseType)
                           throws org.xml.sax.SAXException

Creates a new, local instance of TypeSGChain, as if it were a global type with the given name.

Implementation note: The type TypeSGChain must not be exposed in the interface, because the interface class is used to generate this type. In other words, this interface must be compilable without the TypeSGChain interface.

Throws:
org.xml.sax.SAXException

getTypeSG

TypeSG getTypeSG(XSType pType,
                 XsQName pName,
                 JAXBProperty.BaseType pBaseType)
                 throws org.xml.sax.SAXException

Returns a new instance of TypeSG generating the given type, as if it were a global type with the given name.

Throws:
org.xml.sax.SAXException

newXSParser

XSParser newXSParser()
                     throws org.xml.sax.SAXException

Creates a new instance of XSParser.

Throws:
org.xml.sax.SAXException

newFacet

Facet newFacet(XSType pType,
               XSEnumeration[] pEnumerations)
               throws org.xml.sax.SAXException

Creates a new enumeration facet.

Throws:
org.xml.sax.SAXException

getGroups

GroupSG[] getGroups()

Returns an array of all groups created by the factory.


getTypes

TypeSG[] getTypes()

Returns an array of all types created by the factory.


getObjects

ObjectSG[] getObjects()

Returns an array of all objects created by the factory.