Object
Provides an assortment of utilities for managing XML Bean types, type systems, QNames, paths, and queries.
Object
XmlBeans
Field Summary |
public static |
|
Method Summary |
public static |
|
public static |
|
public static |
|
public static |
|
public static |
|
public static |
|
public static |
|
public static | |
public static | |
public static |
|
public static | |
public static |
|
public static |
|
public static |
|
public static |
|
Methods from class java.lang. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static SchemaType
NO_TYPE
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 |
public staticCompiles an XPath, returning a String equal to that which was passed, but whose identity is that of one which has been precompiled and cached.String
compilePath(String
pathExpr)
throwsXmlException
XmlException
public staticCompiles 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".String
compilePath(String
pathExpr,XmlOptions
options)
throwsXmlException
XmlOptions.setXqueryCurrentNodeVar(String)
method to specify a particular name for the expression
variable that indicates the context node. XmlException
public staticCompiles an XQuery, returning a String equal to that which was passed, but whose identity is that of one which has been precompiled and cached.String
compileQuery(String
queryExpr)
throwsXmlException
XmlException
public staticCompiles 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.String
compileQuery(String
queryExpr,XmlOptions
options)
throwsXmlException
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. XmlException
public staticSchemaTypeSystem
compileXsd(XmlObject
[] schemas,SchemaTypeLoader
typepath,XmlOptions
options)
throwsXmlException
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 XmlBeans.typeLoaderUnion(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:
XmlOptions.setErrorListener(Collection)
.XmlOptions.setCompileNoValidation()
.XmlException
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 staticObtains a name from the thread local QNameCacheQName
getQName(String
localPart)
public staticObtains a name from the thread local QNameCacheQName
getQName(String
namespaceUri,String
localPart)
public static QNameCache
getQNameCache()
Returns a thread local QNameCache
public staticReturns the SchemaTypeSystem that results from compiling the XML schema definitions passed.SchemaTypeLoader
loadXsd(XmlObject
[] schemas)
throwsXmlException
Just like compileTypeSystem, but uses the context type loader for linking, and returns a unioned typeloader that is suitable for creating instances.
XmlException
public staticSchemaTypeLoader
loadXsd(XmlObject
[] schemas,XmlOptions
options)
throwsXmlException
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:
XmlOptions.setErrorListener(Collection)
.XmlOptions.setCompileNoValidation()
.XmlException
public staticReturns the SchemaType from a corresponding XmlObject subclass, or null if none.SchemaType
typeForClass(Class
c)
public staticReturns a SchemaTypeLoader that searches for compiled schema types in the given ClassLoader.SchemaTypeLoader
typeLoaderForClassLoader(ClassLoader
loader)
public staticReturns the union of a list of typeLoaders. The returned SchemaTypeLoader searches the given list of SchemaTypeLoaders in order from first to last.SchemaTypeLoader
typeLoaderUnion(SchemaTypeLoader
[] typeLoaders)