org.apache.xmlbeans
Class XmlBeans

java.lang.Object
  org.apache.xmlbeans.XmlBeans

public final class XmlBeans

extends Object

Provides an assortment of utilities for managing XML Bean types, type systems, QNames, paths, and queries.

Field Summary

static SchemaType

NO_TYPE The SchemaType object given to an XmlObject instance when no type can be determined.

Method Summary

static String	compilePath(String pathExpr) Compiles an XPath, returning a String equal to that which was passed, but whose identity is that of one which has been precompiled and cached.
static String	compilePath(String pathExpr, XmlOptions options) Compiles an XPath, returning a String equal to that which was passed, but whose identity is that of one which has been precompiled and cached; takes an option for specifying text that indicates the name of context node.
static String	compileQuery(String queryExpr) Compiles an XQuery, returning a String equal to that which was passed, but whose identity is that of one which has been precompiled and cached.
static String	compileQuery(String queryExpr, XmlOptions options) Compiles an XQuery, returning a String equal to that which was passed, but whose identity is that of one which has been precompiled and cached; takes an option for specifying text that indicates the context node.
static SchemaTypeSystem	compileXsd(XmlObject[] schemas, SchemaTypeLoader typepath, XmlOptions options) Returns the SchemaTypeSystem that results from compiling the XML schema definitions passed.
static SchemaTypeSystem	getBuiltinTypeSystem() Returns the builtin type system.
static SchemaTypeLoader	getContextTypeLoader() Gets the SchemaTypeLoader based on the current thread's context ClassLoader.
static QName	getQName(String localPart) Obtains a name from the thread local QNameCache
static QName	getQName(String namespaceUri, String localPart) Obtains a name from the thread local QNameCache
static QNameCache	getQNameCache() Returns a thread local QNameCache
static String	getTitle() Returns the XmlBeans Package title, "org.apache.xmlbeans", the value of XmlBeans.class.getPackage().getImplementationTitle().
static String	getVendor() Returns the XmlBeans vendor, "Apache Software Foundation", the value of XmlBeans.class.getPackage().getImplementationVendor().
static String	getVersion() Returns the XmlBeans version the value of XmlBeans.class.getPackage().getImplementationVersion().
static SchemaTypeLoader	loadXsd(XmlObject[] schemas) Returns the SchemaTypeSystem that results from compiling the XML schema definitions passed.
static SchemaTypeLoader	loadXsd(XmlObject[] schemas, XmlOptions options) Returns the SchemaTypeSystem that results from compiling the XML schema definitions passed in schemas.
static SchemaType	typeForClass(Class c) Returns the SchemaType from a corresponding XmlObject subclass, or null if none.
static SchemaTypeLoader	typeLoaderForClassLoader(ClassLoader loader) Returns a SchemaTypeLoader that searches for compiled schema types in the given ClassLoader.
static SchemaTypeLoader	typeLoaderUnion(SchemaTypeLoader[] typeLoaders) Returns the union of a list of typeLoaders.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NO_TYPE

public static SchemaType NO_TYPE

The SchemaType object given to an XmlObject instance when no type can be determined.

The NO_TYPE is the universal derived type. That is, it is derived from all other schema types, and no instances of the NO_TYPE are valid. (It is not to be confused with the anyType, which is the universal base type from which all other types can be derived, and of which all instances are valid.)

Method Detail

getTitle

public static final String getTitle()

Returns the XmlBeans Package title, "org.apache.xmlbeans", the value of XmlBeans.class.getPackage().getImplementationTitle().

getVendor

public static final String getVendor()

Returns the XmlBeans vendor, "Apache Software Foundation", the value of XmlBeans.class.getPackage().getImplementationVendor().

getVersion

public static final String getVersion()

Returns the XmlBeans version the value of XmlBeans.class.getPackage().getImplementationVersion().

getQNameCache

public static QNameCache getQNameCache()

Returns a thread local QNameCache

getQName

public static QName getQName(String localPart)

Obtains a name from the thread local QNameCache

getQName

public static QName getQName(String namespaceUri,
                             String localPart)

Obtains a name from the thread local QNameCache

compilePath

public static String compilePath(String pathExpr)
                          throws XmlException

Compiles an XPath, returning a String equal to that which was passed, but whose identity is that of one which has been precompiled and cached.

Throws:

XmlException

compilePath

public static String compilePath(String pathExpr,
                                 XmlOptions options)
                          throws XmlException

Compiles an XPath, returning a String equal to that which was passed, but whose identity is that of one which has been precompiled and cached; takes an option for specifying text that indicates the name of context node. The default is "this", as in "$this".

Parameters:

options - Options for the path. For example, you can call the XmlOptions.setXqueryCurrentNodeVar(String) method to specify a particular name for the expression variable that indicates the context node.

Throws:

XmlException

compileQuery

public static String compileQuery(String queryExpr)
                           throws XmlException

Compiles an XQuery, returning a String equal to that which was passed, but whose identity is that of one which has been precompiled and cached.

Throws:

XmlException

compileQuery

public static String compileQuery(String queryExpr,
                                  XmlOptions options)
                           throws XmlException

Compiles an XQuery, returning a String equal to that which was passed, but whose identity is that of one which has been precompiled and cached; takes an option for specifying text that indicates the context node.

Parameters:

options - Options for the query. For example, you can call the XmlOptions.setXqueryCurrentNodeVar(String) method to specify a particular name for the expression variable that indicates the context node and the XmlOptions.setXqueryVariables(Map) method to map external variable names to values.

Throws:

XmlException

getContextTypeLoader

public static SchemaTypeLoader getContextTypeLoader()

Gets the SchemaTypeLoader based on the current thread's context ClassLoader. This is the SchemaTypeLoader that is used to assign schema types to XML documents by default. The SchemaTypeLoader is also consulted to resolve wildcards and xsi:type attributes.

The "parse" methods of XmlBeans all delegate to the "parseInstance" methods of the context type loader.

getBuiltinTypeSystem

public static SchemaTypeSystem getBuiltinTypeSystem()

Returns the builtin type system. This SchemaTypeSystem contains only the 46 builtin types defined by the XML Schema specification.

loadXsd

public static SchemaTypeLoader loadXsd(XmlObject[] schemas)
                                throws XmlException

Returns the SchemaTypeSystem that results from compiling the XML schema definitions passed.

Just like compileTypeSystem, but uses the context type loader for linking, and returns a unioned typeloader that is suitable for creating instances.

Throws:

XmlException

loadXsd

public static SchemaTypeLoader loadXsd(XmlObject[] schemas,
                                       XmlOptions options)
                                throws XmlException

Returns the SchemaTypeSystem that results from compiling the XML schema definitions passed in schemas.

This is just like compileTypeSystem, but uses the context type loader for linking, and returns a unioned typeloader that is suitable for creating instances.

Use the options parameter to specify one or both of the following:

• A collection instance that should be used as an error listener during compilation, as described in XmlOptions.setErrorListener(java.util.Collection).
• Whether validation should not be done when building the SchemaTypeSystem, as described in XmlOptions.setCompileNoValidation().

Parameters:

schemas - The schema definitions from which to build the schema type system.

options - Options specifying an error listener and/or validation behavior.

Throws:

XmlException

compileXsd

public static SchemaTypeSystem compileXsd(XmlObject[] schemas,
                                          SchemaTypeLoader typepath,
                                          XmlOptions options)
                                   throws XmlException

Returns the SchemaTypeSystem that results from compiling the XML schema definitions passed.

The XmlObjects passed in should be w3c <schema> elements whose type is org.w3c.x2001.xmlSchema.Schema. (That is, schema elements in the XML namespace http://www.w3c.org/2001/XMLSchema.) Also org.w3c.x2001.xmlSchema.SchemaDocument is permitted.

The optional second argument is a SchemaTypeLoader which will be consulted for already-compiled schema types which may be linked while processing the given schemas.

The SchemaTypeSystem that is returned should be combined (via typeLoaderUnion(org.apache.xmlbeans.SchemaTypeLoader[])) with the typepath typeloader in order to create a typeloader that can be used for creating and validating instances.

Use the options parameter to specify the following:

• A collection instance that should be used as an error listener during compilation, as described in XmlOptions.setErrorListener(java.util.Collection).
• Whether validation should not be done when building the SchemaTypeSystem, as described in XmlOptions.setCompileNoValidation().

Parameters:

schemas - The schema definitions from which to build the schema type system.

typepath - The path to already-compiled schema types for linking while processing.

options - Options specifying an error listener and/or validation behavior.

Throws:

XmlException

typeLoaderUnion

public static SchemaTypeLoader typeLoaderUnion(SchemaTypeLoader[] typeLoaders)

Returns the union of a list of typeLoaders. The returned SchemaTypeLoader searches the given list of SchemaTypeLoaders in order from first to last.

typeLoaderForClassLoader

public static SchemaTypeLoader typeLoaderForClassLoader(ClassLoader loader)

Returns a SchemaTypeLoader that searches for compiled schema types in the given ClassLoader.

typeForClass

public static SchemaType typeForClass(Class c)

Returns the SchemaType from a corresponding XmlObject subclass, or null if none.