org.apache.ws.jaxme.xs
Interface XSSchema

All Superinterfaces:
XSObject, XSOpenAttrs
All Known Subinterfaces:
JAXBSchema
All Known Implementing Classes:
JAXBSchemaImpl, XSSchemaImpl

public interface XSSchema
extends XSOpenAttrs

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(XSIdentityConstraint ic)
          Adds a new identity constraint to the schema.
 void add(XSKeyRef rf)
          Adds a new key ref 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.
 java.util.Map getIdentityConstraints()
          Returns a map of XSIdentityConstraint objects.
 java.util.Map getKeyRefs()
          Returns a map of XSKeyRef objects.
 XsAnyURI getTargetNamespace()
          Returns the schemas target namespace.
 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 org.apache.ws.jaxme.xs.XSOpenAttrs
getOpenAttributes
 
Methods inherited from interface org.apache.ws.jaxme.xs.XSObject
getLocator, getParentObject, getXSSchema, isTopLevelObject, validate
 

Method Detail

getXSObjectFactory

XSObjectFactory getXSObjectFactory()

Returns the schemas object factory.


getContext

XSContext getContext()

Returns the schemas context.


getTargetNamespace

XsAnyURI getTargetNamespace()

Returns the schemas target namespace. Note, that a logical schema can combine elements, attributes, groups, and types of various namespaces by importing other syntactical schemas with different namespaces. Thus the logical schemas target namespace is in fact the target namespace of the outermost syntactical schema.

Returns:
Target namespace or null for null (default namespace)

getAnnotations

XSAnnotation[] getAnnotations()

Returns the array of annotations.


getTypes

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

XSType[] getBuiltinTypes()

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

See Also:
getTypes()

getType

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

XSGroup[] getGroups()

Returns the array of global groups.


getGroup

XSGroup getGroup(XsQName pName)

Returns the group with the given name.


getAttributeGroups

XSAttributeGroup[] getAttributeGroups()

Returns the array of global attribute groups.


getAttributeGroup

XSAttributeGroup getAttributeGroup(XsQName pName)

Returns the attribute group with the given name.


getElements

XSElement[] getElements()

Returns the array of global elements.


getElement

XSElement getElement(XsQName pName)

Returns the element with the given name.


getAttributes

XSAttribute[] getAttributes()

Returns the array of global attributes.


getAttribute

XSAttribute getAttribute(XsQName pName)

Returns the attribute with the given name.


getIdentityConstraints

java.util.Map getIdentityConstraints()

Returns a map of XSIdentityConstraint objects. The key is the constraints name. The map is immutable.


getKeyRefs

java.util.Map getKeyRefs()

Returns a map of XSKeyRef objects. The key is the key refs name. The map is immutable.


getChilds

java.lang.Object[] getChilds()

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


add

void add(XSAnnotation pAnnotation)

Adds a new annotation to the schema.


add

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

Adds a new type to the schema.

Throws:
org.xml.sax.SAXException

redefine

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

Redefines an existing type in the schema.

Throws:
org.xml.sax.SAXException

add

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

Adds a new group to the schema.

Throws:
org.xml.sax.SAXException

redefine

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

Redefines an existing group in the schema.

Throws:
org.xml.sax.SAXException

add

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

Adds a new attribute group to the schema.

Throws:
org.xml.sax.SAXException

redefine

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

Redefines an existing attribute group in the schema.

Throws:
org.xml.sax.SAXException

add

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

Adds a new attribute to the schema.

Throws:
org.xml.sax.SAXException

add

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

Adds a new element to the schema.

Throws:
org.xml.sax.SAXException

add

void add(XSNotation pNotation)
         throws org.xml.sax.SAXException

Adds a new notation to the schema.

Throws:
org.xml.sax.SAXException

add

void add(XSIdentityConstraint ic)
         throws org.xml.sax.SAXException

Adds a new identity constraint to the schema.

Throws:
org.xml.sax.SAXException

add

void add(XSKeyRef rf)
         throws org.xml.sax.SAXException

Adds a new key ref to the schema.

Throws:
org.xml.sax.SAXException