net.sf.jaxme.xs
Interface XSSchema

All Superinterfaces:

XSObject

All Known Subinterfaces:

JAXBSchema

All Known Implementing Classes:

JAXBSchemaImpl, XSSchemaImpl

public interface XSSchema

extends XSObject

This interface is what you are probably most interested in: The logical XML Schema representation.

Author:

Jochen Wiedmann

Method Summary

void	add(XSAnnotation pAnnotation) Adds a new annotation to the schema.
void	add(XSAttribute pAttribute) Adds a new attribute to the schema.
void	add(XSAttributeGroup pGroup) Adds a new attribute group to the schema.
void	add(XSElement pElement) Adds a new element to the schema.
void	add(XSGroup pGroup) Adds a new group to the schema.
void	add(XSNotation pNotation) Adds a new notation to the schema.
void	add(XSType pType) Adds a new type to the schema.
XSAnnotation[]	getAnnotations() Returns the array of annotations.
XSAttribute	getAttribute(XsQName pName) Returns the attribute with the given name.
XSAttributeGroup	getAttributeGroup(XsQName pName) Returns the attribute group with the given name.
XSAttributeGroup[]	getAttributeGroups() Returns the array of global attribute groups.
XSAttribute[]	getAttributes() Returns the array of global attributes.
XSType[]	getBuiltinTypes() Returns the array of builtin types.
java.lang.Object[]	getChilds() Returns all the schema annotations, types, groups, attribute groups, elements, and attributes, in the order of declaration.
XSContext	getContext() Returns the schemas context.
XSElement	getElement(XsQName pName) Returns the element with the given name.
XSElement[]	getElements() Returns the array of global elements.
XSGroup	getGroup(XsQName pName) Returns the group with the given name.
XSGroup[]	getGroups() Returns the array of global groups.
XSType	getType(XsQName pName) Returns the type with the given name.
XSType[]	getTypes() Returns the array of global types.
XSObjectFactory	getXSObjectFactory() Returns the schemas object factory.
void	redefine(XSAttributeGroup pGroup) Redefines an existing attribute group in the schema.
void	redefine(XSGroup pGroup) Redefines an existing group in the schema.
void	redefine(XSType pType) Redefines an existing type in the schema.

Methods inherited from interface net.sf.jaxme.xs.XSObject

getLocator, getParentObject, getXSSchema, isTopLevelObject, validate

Method Detail

getXSObjectFactory

public XSObjectFactory getXSObjectFactory()

Returns the schemas object factory.

getContext

public XSContext getContext()

Returns the schemas context.

getAnnotations

public XSAnnotation[] getAnnotations()

Returns the array of annotations.

getTypes

public XSType[] getTypes()

Returns the array of global types. This includes simple and complex types. The builtin types are not included.

See Also:

getType(XsQName)

getBuiltinTypes

public XSType[] getBuiltinTypes()

Returns the array of builtin types. This includes simple and complex types.

See Also:

getTypes()

getType

public XSType getType(XsQName pName)

Returns the type with the given name. This may be a builtin type or a type defined by the schema.

getGroups

public XSGroup[] getGroups()

Returns the array of global groups.

getGroup

public XSGroup getGroup(XsQName pName)

Returns the group with the given name.

getAttributeGroups

public XSAttributeGroup[] getAttributeGroups()

Returns the array of global attribute groups.

getAttributeGroup

public XSAttributeGroup getAttributeGroup(XsQName pName)

Returns the attribute group with the given name.

getElements

public XSElement[] getElements()

Returns the array of global elements.

getElement

public XSElement getElement(XsQName pName)

Returns the element with the given name.

getAttributes

public XSAttribute[] getAttributes()

Returns the array of global attributes.

getAttribute

public XSAttribute getAttribute(XsQName pName)

Returns the attribute with the given name.

getChilds

public java.lang.Object[] getChilds()

Returns all the schema annotations, types, groups, attribute groups, elements, and attributes, in the order of declaration.

add

public void add(XSAnnotation pAnnotation)

Adds a new annotation to the schema.

add

public void add(XSType pType)
         throws org.xml.sax.SAXException

Adds a new type to the schema.

Throws:

org.xml.sax.SAXException

redefine

public void redefine(XSType pType)
              throws org.xml.sax.SAXException

Redefines an existing type in the schema.

Throws:

org.xml.sax.SAXException

add

public void add(XSGroup pGroup)
         throws org.xml.sax.SAXException

Adds a new group to the schema.

Throws:

org.xml.sax.SAXException

redefine

public void redefine(XSGroup pGroup)
              throws org.xml.sax.SAXException

Redefines an existing group in the schema.

Throws:

org.xml.sax.SAXException

add

public void add(XSAttributeGroup pGroup)
         throws org.xml.sax.SAXException

Adds a new attribute group to the schema.

Throws:

org.xml.sax.SAXException

redefine

public void redefine(XSAttributeGroup pGroup)
              throws org.xml.sax.SAXException

Redefines an existing attribute group in the schema.

Throws:

org.xml.sax.SAXException

add

public void add(XSAttribute pAttribute)
         throws org.xml.sax.SAXException

Adds a new attribute to the schema.

Throws:

org.xml.sax.SAXException

add

public void add(XSElement pElement)
         throws org.xml.sax.SAXException

Adds a new element to the schema.

Throws:

org.xml.sax.SAXException

add

public void add(XSNotation pNotation)

Adds a new notation to the schema.