Home » xmlbeans-2.5.0-src » org.apache » xmlbeans » [javadoc | source]
org.apache.xmlbeans
public final class: XmlBeans [javadoc | source]
java.lang.Object
   org.apache.xmlbeans.XmlBeans
Provides an assortment of utilities for managing XML Bean types, type systems, QNames, paths, and queries.
Field Summary
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 from org.apache.xmlbeans.XmlBeans Summary:
compilePath,   compilePath,   compileQuery,   compileQuery,   compileXmlBeans,   compileXsd,   compileXsd,   getBuiltinTypeSystem,   getContextTypeLoader,   getQName,   getQName,   getQNameCache,   getTitle,   getVendor,   getVersion,   loadXsd,   loadXsd,   nodeToCursor,   nodeToXmlObject,   nodeToXmlStreamReader,   resourceLoaderForPath,   streamToNode,   typeForClass,   typeLoaderForClassLoader,   typeLoaderForResource,   typeLoaderUnion,   typeSystemForClassLoader
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.xmlbeans.XmlBeans Detail:
 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.
 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".
 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.
 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.
 public static SchemaTypeSystem compileXmlBeans(String name,
    SchemaTypeSystem system,
    XmlObject[] schemas,
    BindingConfig config,
    SchemaTypeLoader typepath,
    Filer filer,
    XmlOptions options) throws XmlException 

    Returns the SchemaTypeSystem that results from augumenting the SchemaTypeSystem passed in by incrementally adding the given XML schema definitions.

    These could be new definitions (if the Schema document is not recorded into the existing SchemaTypeSystem), modifications to the already existing definitions (if the Schema document is already recorded in the existing SchemaTypeSystem), or deletions (if the Schema document is already recorded in the existing SchemaTypeSystem and the new definitions are empty). The identity of documents is established using XmlDocumentProperties#getSourceName , so if the caller choses to construct the Schema definitions using other methods than parsing an XML document, they should make sure that the names returned by that method are consistent with the caller's intent (add/modify).

    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 name argument is used to name the compiled schema type system. A randomly generated name will be used if the name is null.

    The optional BindingConfig argument is used to control the shape of the generated code. A BindingConfig isn't used if Filer is null.

    The optional SchemaTypeLoader argument will be consulted for already-compiled schema types which may be linked while processing the given schemas. If not specified, the context typeloader (as returned by #getContextTypeLoader ) will be used.

    The optional Filer argument is used to create new binary or source files which are the product of the compilation. If the Filer is null, the schema binaries (.xsb) files and source files won't be generated.

    The SchemaTypeSystem that is returned should be combined (via #typeLoaderUnion ) 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:

 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 ) 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:

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

    Returns the SchemaTypeSystem that results from augumenting the SchemaTypeSystem passed in by incrementally adding the given XML schema definitions.

    These could be new definitions (if the Schema document is not recorded into the existing SchemaTypeSystem), modifications to the already existing definitions (if the Schema document is already recorded in the existing SchemaTypeSystem), or deletions (if the Schema document is already recorded in the existing SchemaTypeSystem and the new definitions are empty). The identity of documents is established using XmlDocumentProperties#getSourceName , so if the caller choses to construct the Schema definitions using other methods than parsing an XML document, they should make sure that the names returned by that method are consistent with the caller's intent (add/modify).

    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 ) 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:

 public static SchemaTypeSystem getBuiltinTypeSystem() 
    Returns the builtin type system. This SchemaTypeSystem contains only the 46 builtin types defined by the XML Schema specification.
 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.

 public static QName getQName(String localPart) 
    Obtains a name from the thread local QNameCache
 public static QName getQName(String namespaceUri,
    String localPart) 
    Obtains a name from the thread local QNameCache
 public static QNameCache getQNameCache() 
    Returns a thread local QNameCache
 public static final String getTitle() 
 public static final String getVendor() 
 public static final String getVersion() 
 public static SchemaTypeLoader loadXsd(XmlObject[] schemas) throws XmlException 
    Returns the SchemaTypeSystem that results from compiling the XML schema definitions passed.

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

 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 compileXsd, 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:

 public static XmlCursor nodeToCursor(Node n) 
    Creates an XmlCursor for a DOM node which is implemented by XmlBwans
 public static XmlObject nodeToXmlObject(Node n) 
    Creates an XmlObject for a DOM node which is implemented by XmlBwans
 public static XMLStreamReader nodeToXmlStreamReader(Node n) 
    Creates an XmlObject for a DOM node which is implemented by XmlBwans
 public static ResourceLoader resourceLoaderForPath(File[] path) 
    Returns a new ResourceLoader for a search path where each component of the path is either a directory or a compiled xbean jar.
 public static Node streamToNode(XMLStreamReader xs) 
    Returns the XmlObject for a DOM node which is implemented by XmlBwans
 public static SchemaType typeForClass(Class c) 
    Returns the SchemaType from a corresponding XmlObject subclass, or null if none.
 public static SchemaTypeLoader typeLoaderForClassLoader(ClassLoader loader) 
    Returns a SchemaTypeLoader that searches for compiled schema types in the given ClassLoader.
 public static SchemaTypeLoader typeLoaderForResource(ResourceLoader resourceLoader) 
    Returns a SchemaTypeLoader that searches for compiled schema types in the given ResourceLoader.
 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.
 public static SchemaTypeSystem typeSystemForClassLoader(ClassLoader loader,
    String stsName)