Home » xmlbeans-2.5.0-src » org.apache » xmlbeans » [javadoc | source]
org.apache.xmlbeans
public interface: SchemaTypeLoader [javadoc | source]

All Known Implementing Classes:
    SchemaTypeLoaderImpl, XQuerySchemaTypeSystem, BuiltinSchemaTypeSystem, SchemaTypeSystem, SchemaTypeLoaderBase, SchemaTypeSystemImpl, SoapEncSchemaTypeSystem

Represents a searchable set of XML Schema component definitions.

SchemaTypeLoader is somewhat analogous to java.lang.ClassLoader , because it is responsible for finding SchemaComponent definitions by name, yet it is not responsible for being able to enumerate all the component definitons available. (If you wish to enumerate component definitions, see SchemaTypeSystem .) There are some ways in which SchemaTypeSystems are dissimilar from ClassLoaders, however. Since XML Schema has a number of instance-oriented typing mechanisms (such as wildcards) that do not exist in Java, a SchemaTypeLoader is not associated with a type; instead, a SchemaTypeLoader is associated with each XML instance.

Every XML instance is loaded within the context of a SchemaTypeLoader; the SchemaTypeLoader for an instance is used to resolve all type definitions within the instance and for applying type-sensitive methods such as XmlObject#validate .

Normally the SchemaTypeLoader being used for all instances is the context type loader (that is, the SchemaTypeLoader returned from XmlBeans#getContextTypeLoader() ). The context type loader consults the thread's context ClassLoader (see Thread#getContextClassLoader() ) to find schema type defintions that are available on the classpath. The net result is that you can use schema types simply by putting their compiled schema JARs on your classpath. If you wish to load instances using a different SchemaTypeLoader, then you must call #parse methods on the SchemaTypeLoader instance explicitly rather than using the normal convenient Factory methods.

A SchemaTypeLoader can be obtained by dynamically loading XSD files using XmlBeans#loadXsd , or by assembling other SchemaTypeLoaders or SchemaTypeSystems on a path using XmlBeans#typeLoaderUnion .

Method from org.apache.xmlbeans.SchemaTypeLoader Summary:
compilePath,   compileQuery,   findAttribute,   findAttributeGroup,   findAttributeGroupRef,   findAttributeRef,   findAttributeType,   findAttributeTypeRef,   findDocumentType,   findDocumentTypeRef,   findElement,   findElementRef,   findIdentityConstraintRef,   findModelGroup,   findModelGroupRef,   findType,   findTypeRef,   getSourceAsStream,   isNamespaceDefined,   newDomImplementation,   newInstance,   newValidatingXMLInputStream,   newXmlSaxHandler,   parse,   parse,   parse,   parse,   parse,   parse,   parse,   parse,   typeForClassname,   typeForSignature
Method from org.apache.xmlbeans.SchemaTypeLoader Detail:
 public String compilePath(String pathExpr,
    XmlOptions options) throws XmlException
    Compiles an XPath
 public String compileQuery(String queryExpr,
    XmlOptions options) throws XmlException
    Compiles an XQuery
 public SchemaGlobalAttribute findAttribute(QName name)
    Returns the global attribute defintion with the given name, or null if none.
 public SchemaAttributeGroup findAttributeGroup(QName name)
    Returns the attribute group defintion with the given name, or null if none.
 public Ref findAttributeGroupRef(QName name)
    Used for on-demand loading.
 public Ref findAttributeRef(QName name)
    Used for on-demand loading.
 public SchemaType findAttributeType(QName name)
    Returns the attribute type containing the given attribute name, or null if none.
 public Ref findAttributeTypeRef(QName name)
    Used for on-demand loading.
 public SchemaType findDocumentType(QName name)
    Returns the document type rooted at the given element name, or null if none.
 public Ref findDocumentTypeRef(QName name)
    Used for on-demand loading.
 public SchemaGlobalElement findElement(QName name)
    Returns the global element defintion with the given name, or null if none.
 public Ref findElementRef(QName name)
    Used for on-demand loading.
 public Ref findIdentityConstraintRef(QName name)
    Used for on-demand loading.
 public SchemaModelGroup findModelGroup(QName name)
    Returns the model group defintion with the given name, or null if none.
 public Ref findModelGroupRef(QName name)
    Used for on-demand loading.
 public SchemaType findType(QName name)
    Returns the type with the given name, or null if none.
 public Ref findTypeRef(QName name)
    Used for on-demand loading.
 public InputStream getSourceAsStream(String sourceName)
 public boolean isNamespaceDefined(String namespace)
    True if the typeloader contains any definitions in the given namespace.
 public DOMImplementation newDomImplementation(XmlOptions options)
    Returns a DOMImplementation.
 public XmlObject newInstance(SchemaType type,
    XmlOptions options)
    Creates an instance of the given type.
 public XMLInputStream newValidatingXMLInputStream(XMLInputStream xis,
    SchemaType type,
    XmlOptions options) throws XmlException, XMLStreamExceptionDeprecated! Deprecated -  by XMLStreamReader from STaX - jsr173 API.

    Returns a validating XMLInputStream that will throw an exception if the XML is not valid
 public XmlSaxHandler newXmlSaxHandler(SchemaType type,
    XmlOptions options)
    Returns an XmlSaxHandler that can parse an instance of the given type.
 public XmlObject parse(String xmlText,
    SchemaType type,
    XmlOptions options) throws XmlException
    Parses an instance of the given type.
 public XmlObject parse(File file,
    SchemaType type,
    XmlOptions options) throws XmlException, IOException
    Parses an instance of the given type.
 public XmlObject parse(URL file,
    SchemaType type,
    XmlOptions options) throws XmlException, IOException
    Parses an instance of the given type.
 public XmlObject parse(InputStream jiois,
    SchemaType type,
    XmlOptions options) throws XmlException, IOException
    Parses an instance of the given type.
 public XmlObject parse(XMLStreamReader xsr,
    SchemaType type,
    XmlOptions options) throws XmlException
    Parses an instance of the given type.
 public XmlObject parse(Reader jior,
    SchemaType type,
    XmlOptions options) throws XmlException, IOException
    Parses an instance of the given type.
 public XmlObject parse(Node node,
    SchemaType type,
    XmlOptions options) throws XmlException
    Parses an instance of the given type.
 public XmlObject parse(XMLInputStream xis,
    SchemaType type,
    XmlOptions options) throws XmlException, XMLStreamExceptionDeprecated! Deprecated -  by XMLStreamReader from STaX - jsr173 API.

    Parses an instance of the given type.
 public SchemaType typeForClassname(String classname)
    Finds a type for a given fully-qualified XML Bean classname
 public SchemaType typeForSignature(String signature)
    Finds a type for a given signature string