03 LTE Radio Parameters System Info v20

7/26/2019 03 LTE Radio Parameters System Info v20

1/349

a href="javascript:reloadTOC('../../../com/bea/xml/XmlOptions.html')" target="_self">XmlOptionsoptions)
throws XmlException, IOExceptionParses a XmlNonNegativeInteger fragment from an InputStream.
ExceptionsXmlExceptionIOExceptionparse(Reader) Methodpublic static XmlNonNegativeInteger parse(Readerr)
throws XmlException, IOExceptionParses a XmlNonNegativeInteger fragment from a Reader. ExceptionsXmlExceptionIOExceptionparse(Reader, XmlOptions) Methodpublic static XmlNonNegativeInteger parse(Readerr,
XmlOptionsoptions)
throws XmlException,IOExceptionParses a XmlNonNegativeInteger


2/349

DE> fragment from a Reader.
ExceptionsXmlExceptionIOExceptionparse(Node) Methodpublic static XmlNonNegativeInteger parse(Nodenode)
throws XmlExceptionParses a XmlNonNegativeInteger fragment from a DOM Node. ExceptionsXmlExceptionparse(Node, XmlOptions) Methodpublic static XmlNonNegativeInteger parse(Nodenode,
XmlOptionsoptions)
throws XmlExceptionParses a XmlNonNegativeInteger fragment from a DOM Node.
Exceptions
XmlExceptionparse(XMLInputStream) Method

DEPRECATED Superceded by JSR 173


3/349
public static XmlNonNegativeInteger parse(XMLInputStreamxis)
throws XmlException, XMLStreamExceptionParses a XmlNonNegativeInteger fragment from an XMLInputStream. ExceptionsXmlExceptionXMLStreamException
parse(XMLInputStream, XmlOptions) Method

public static XmlNonNegativeInteger parse(XMLInputStreamxis,
XmlOptionsoptions)
throws XmlException,XMLStreamExceptionParses a XmlNonNegativeInteger fragment from an XMLInputStream.
ExceptionsXmlException
XMLStreamException

writeTopicInfo();


4/349

XmlNonNegativeIntegerInterface displayInFrames();

com.bea.xml
XmlNonNegativeInteger Interfacepublic interface XmlNonNegativeInteger
extends XmlInteger

Corresponds to the XML Schemaxs:nonNegativeInteger type.One of the derived types based on xs:decimal.

Verified to be zero or positive when validating.

Convertible to BigInteger.

All SuperinterfacesXmlAnySimpleType, XmlDecimal, XmlInteger, XmlObject, XmlTokenSource

All Known Subinterfaces
XmlPositiveInteger,


5/349

('../../../com/bea/xml/XmlUnsignedByte.html')" target="_self">XmlUnsignedByte, XmlUnsignedInt, XmlUnsignedLong, XmlUnsignedShortNested Class Summarypublic static finalclassXmlNonNegativeInteger.Factory

A class

with methods for creating instancesof XmlNonNegativeInteger.Nested classes from interfacecom.bea.xml.XmlAnySimpleType

XmlAnySimpleType.FactoryNested classes from interfacecom.bea.xml.XmlDecimal

XmlDecimal.FactoryNested classes from interfacecom.bea.xml.XmlInteger


6/349

XmlInteger.FactoryNested classes from interfacecom.bea.xml.XmlObjectXmlObject.Factory

Field Summary

public static finalSchemaTypetype

The constant SchemaType object representing this schema type.

Fields from interfacecom.bea.xml.XmlAnySimpleTypetype


7/349

Fields from interfacecom.bea.xml.XmlDecimaltype

Fields from interfacecom.bea.xml.XmlInteger

type

Fields from interfacecom.bea.xml.XmlObject

EQUAL, GREATER_THAN, LESS_THAN, NOT_EQUAL, type

Method Summary


8/349

Methods from interfacecom.bea.xml.XmlAnySimpleTypegetStringValue, set, setStringValue, stringValue

Methods from interfacecom.bea.xml.XmlDecimalbigDecimalValue, getBigDecimalValue, set, setBigDecimalValue

Methods from interfacecom.bea.xml.XmlIntegerbigIntegerValue, getBigIntegerValue, set, setBigIntegerValue


9/349

Methods from interfacecom.bea.xml.XmlObjectchangeType, compareTo, compareValue, copy, execQuery, execQuery, isImmutable, isNil, schemaType,

selectPath, selectPath, set, setNil, toString, validate, validate, valueEquals, valueHashCode

Methods from interfacecom.bea.xml.XmlTokenSource

documentProperties, monitor, newCursor, newDomNode, newDomNode,


10/349

reloadTOC('../../../com/bea/xml/XmlTokenSource.html#newInputStream()')" target="_self">newInputStream, newInputStream, newReader, newReader, newXMLInputStream, newXMLInputStream, save, save, save, save, save, save, save, save, xmlText, xmlText

Field Detailtypepublic static final SchemaType type


writeTopicInfo();


11/349

XmlNonPositiveInteger.FactoryClass displayInFrames();

com.bea.xml
XmlNonPositiveInteger.Factory Classpublic static final class XmlNonPositiveInteger.Factory
extends Object

A class with methods for creating instancesof XmlNonPositiveInteger.
Hierarchy
Object

XmlNonPositiveInteger.FactoryEnclosing interface
XmlNonPositiveInteger

Method Summary


12/349

public static XmlNonPositiveIntegernewInstance()

Creates an empty instance of XmlNonPositiveIntegerpublic static XmlNonPositiveIntegernewInstance(XmlOptions options)

Creates an empty instance of XmlNonPositiveIntegerpublic stat

ic XMLInputStreamnewValidatingXMLInputStream(XMLInputStream xis)

Returns a validating XMLInputStream.

public static XMLInputStreamnewValidatingXMLInputStream(


13/349

ea.com/wls/docs81/javadocs/weblogic/xml/stream/XMLInputStream.html" target="_blank">XMLInputStream xis, XmlOptions options)

Returns a validating XMLInputStream.public static XmlNonPositiveIntegernewValue(Object obj)

Creates an immutable XmlNonPositiveInteger value

public static XmlNonPositiveIntegerparse(String s)

Parses a XmlNonPositiveInteger fragment from a String. public static XmlNonPositiveIntegerparse(String s, XmlOptions options)

Parses a XmlNonPositiveInteger fragment from a String.


14/349

public static XmlNonPositiveIntegerparse(File f)

Parses a XmlNonPositiveInteger fragment from a File.public static XmlNonPositiveInteger

parse(File f, XmlOptions options)

Parses a XmlNonPositiveInteger fragment from a File.

public static XmlNonPositiveIntegerparse(URL u)

Parses a XmlNonPositiveInteger fragment from a URL.

public static XmlNonPositiveInteger


15/349

e(java.net.URL, com.bea.xml.XmlOptions)')">parse(URL u, XmlOptions options)

Parses a XmlNonPositiveInteger fragment from a URL.public static XmlNonPositiveIntegerparse(InputStream is)

Parses a XmlNonPositiveInteger fragment from an InputStream.public static XmlNonPositiveIntegerparse(InputStream is, XmlOptions options)

Parses a XmlNonPositiveInteger fragment from an InputStream.public static XmlNonPositiveIntegerparse(Reader r)

Parses a XmlNonPositiveInteger


16/349

> fragment from a Reader.public static XmlNonPositiveIntegerparse(Reader r, XmlOptions options)

Parses a XmlNonPositiveInteger fragment from a Reader.

public static XmlNonPositiveIntegerparse(Nodenode)

Parses a XmlNonPositiveInteger fragment from a DOM Node.

public static XmlNonPositiveIntegerparse(Node node, XmlOptions options)

Parses a XmlNonPositiveInteger fragment from a DOM Node.


17/349

public static XmlNonPositiveIntegerparse(XMLInputStream xis)

Parses a XmlNonPositiveInteger fragment from an XMLInputStream.public static XmlNonPositiveIntegerparse(XMLInputStream xis, XmlOptions options)

Parses a XmlNonPositiveInteger fragment from an XMLInputStream.

Methods from classjava.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait,


18/349

">wait, wait

Method DetailnewInstance() Methodpublic static XmlNonPositiveInteger newInstance()Creates an empty instance of XmlNonPositiveInteger
newInstance(XmlOptions) Methodpublic static XmlNonPositiveInteger newInstance(XmlOptionsoptions)Creates an empty instance of XmlNonPositiveInteger
newValidatingXMLInputStream(XMLInputStream) Method

public static XMLInputStream newValidatingXMLInputStream(XMLInputStreamxis)
throws XmlException, XMLStreamExceptionReturns a validating XMLInputStream. ExceptionsXmlException


19/349

XMLStreamExceptionnewValidatingXMLInputStream(XMLInputStream, XmlOptions) Method

public static XMLInputStream newValidatingXMLInputStream(XMLInputStreamxis,
XmlOptionsoptions)
throws XmlException, XMLStreamExceptionReturns a validating XMLInputStream.
ExceptionsXmlExceptionXMLStreamException
newValue(Object) Methodpublic static XmlNonPositiveInteger newValue(Objectobj)Creates an immutable XmlNonPositiveInteger value

parse(String) Methodpublic static XmlNonPositiveInteger parse(Strings)
throws XmlExceptionParses a XmlNonPositiveInteger


20/349

DE> fragment from a String. For example: "-1234567890".
ExceptionsXmlExceptionparse(String, XmlOptions) Methodpublic static XmlNonPositiveInteger parse(Strings,
XmlOptionsoptions)
throws XmlExceptionParses a XmlNonPositiveInteger fragment from a String. For example: "-1234567890".
ExceptionsXmlExceptionparse(File) Method
public static XmlNonPositiveInteger parse(Filef)
throws XmlException, IOExceptionParses a XmlNonPositiveInteger fragment from a File.
Exceptions
XmlExceptionIOException


21/349

parse(File, XmlOptions) Methodpublic static XmlNonPositiveInteger parse(Filef,

XmlOptionsoptions)
throws XmlException,IOExceptionParses a XmlNonPositiveInteger fragment from a File.
ExceptionsXmlExceptionIOException
parse(URL) Methodpublic static XmlNonPositiveInteger parse(URLu)
throws XmlException, IOException

Parses a XmlNonPositiveInteger fragment from a URL.
parse(URL, XmlOptions) Methodpublic static XmlNonPositiveInteger parse(URLu,


22/349

./../com/bea/xml/XmlOptions.html')" target="_self">XmlOptionsoptions)
throws XmlException,IOExceptionParses a XmlNonPositiveInteger fragment from a URL.
ExceptionsXmlExceptionIOExceptionparse(InputStream) Methodpublic static XmlNonPositiveInteger parse(InputStreamis)
throws XmlException, IOExceptionParses a XmlNonPositiveInteger fragment from an InputStream. Exceptions
XmlExceptionIOExceptionparse(InputStream, XmlOptions) Methodpublic static XmlNonPositiveInteger parse(InputStreamis,

XmlOptionsoptions)
throws XmlException,IOExceptionParses a


23/349

eInteger.html')" target="_self">XmlNonPositiveInteger fragment from an InputStream.
ExceptionsXmlExceptionIOExceptionparse(Reader) Methodpublic static XmlNonPositiveInteger parse(Readerr)
Parses a XmlNonPositiveInteger fragment from a Reader.
parse(Reader, XmlOptions) Methodpublic static XmlNonPositiveInteger parse(Readerr,

XmlOptionsoptions)
throws XmlException,

IOExceptionParses a XmlNonPositiveInteger fragment from a Reader.


24/349

IOExceptionparse(Node) Methodpublic static XmlNonPositiveInteger parse(Nodenode)
throws XmlExceptionParses a XmlNonPositiveInteger fragment from a DOM Node.
parse(Node, XmlOptions) Methodpublic static XmlNonPositiveInteger parse(Nodenode,

XmlOptionsoptions)
throws XmlExceptionParses a XmlNonPositiveInteger fragment from a DOM Node.
parse(XMLInputStream) Method

public static XmlNonPositiveInteger parse(XMLInputStreamxi


25/349

s)
throws XmlException, XMLStreamExceptionParses a XmlNonPositiveInteger fragment from an XMLInputStream.
ExceptionsXmlExceptionXMLStreamExceptionparse(XMLInputStream, XmlOptions) Method

public static XmlNonPositiveInteger parse(XMLInputStreamxis,

XmlOptionsoptions)
throws XmlException,XMLStreamExceptionParses a XmlNonPositiveInteger fragment from an XMLInputStream.
writeTopicInfo();


26/349

XmlNonPositiveIntegerInterface displayInFrames();

com.bea.xml
XmlNonPositiveInteger Interfacepublic interface XmlNonPositiveInteger
extends XmlInteger

Corresponds to the XML Schemaxs:nonPositiveInteger type.One of the derived types based on xs:decimal.

Verified to be zero or negative when validating.

Convertible to BigInteger.
All SuperinterfacesXmlAnySimpleType, XmlDecimal, XmlInteger, XmlObject, XmlTokenSourceAll Known Subinterfaces

XmlNegativeInteger


27/349

Nested Class Summarypublic static finalclassXmlNonPositiveInteger.Factory

A classwith methods for creating instancesof XmlNonPositiveInteger.Nested classes from interfacecom.bea.xml.XmlAnySimpleTypeXmlAnySimpleType.FactoryNested classes from interfacecom.bea.xml.XmlDecimal

XmlDecimal.FactoryNested classes from interfacecom.bea.xml.XmlInteger

XmlInteger.FactoryNested classes from interfacecom.bea.xml.XmlObject


28/349

XmlObject.Factory

Field Summarypublic static finalSchemaTypetype



Fields from interfacecom.bea.xml.XmlDecimaltype


29/349

Fields from interfacecom.bea.xml.XmlIntegertype



Method Summary

Methods from interfacecom.bea.xml.XmlAnySimpleTypegetStringValue, set,


30/349

rget="_self">setStringValue, stringValue

Methods from interfacecom.bea.xml.XmlDecimalbigDecimalValue, getBigDecimalValue, set, setBigDecimalValue

Methods from interfacecom.bea.xml.XmlIntegerbigIntegerValue, getBigIntegerValue, set, setBigIntegerValue

Methods from interfacecom.bea.xml.XmlObjectchangeType, compareTo,


31/349

t)')" target="_self">compareValue, copy, execQuery, execQuery, isImmutable, isNil, schemaType, selectPath, selectPath, set, setNil, toString, validate, validate,

valueEquals, valueHashCode


documentProperties, monitor, newCursor, newDomNode, newDomNode, newInputStream, newInputStream, newReader, newReader, newXMLInputStream, newXMLInputStream,


32/349

ml.sax.ContentHandler, org.xml.sax.ext.LexicalHandler)')" target="_self">save, save, save, save, save, save, save, save, xmlText, xmlText



writeTopicInfo();

XmlNormalizedString.FactoryClass


33/349

displayInFrames();

com.bea.xml
XmlNormalizedString.Factory Classpublic static final class XmlNormalizedString.Factory
extends Object

A class with methods for creating instancesof XmlNormalizedString.
Hierarchy
Object
XmlNormalizedString.FactoryEnclosing interface
XmlNormalizedString
Method Summary

public static XmlNormalizedStringnewInstance()

Creates an empty instance of XmlNormalizedString


34/349

public static XmlNormalizedStringnewInstance(XmlOptions options)

Creates an empty instance of XmlNormalizedString

public static XMLInputStreamnewValidatingXMLInputStream(XMLInputStream xis)


public static XMLInputStreamnewValidatingXMLInputStream(XMLInputStream xis, XmlOptionsoptions)

Returns a validating XMLInputStream.public static


35/349

)" target="_self">XmlNormalizedStringnewValue(Object obj)

Creates an immutable XmlNormalizedString valuepublic static XmlNormalizedStringparse(Strings)

Parses a XmlNormalizedString fragment from a String. public static XmlNormalizedString

parse(String s, XmlOptions options)

Parses a XmlNormalizedString fragment from a String.

public static XmlNormalizedStringparse(File f)


36/349

Parses a XmlNormalizedString fragment from a File.public static XmlNormalizedStringparse(File f, XmlOptions options)

Parses a XmlNormalizedString fragment from a File.

public static XmlNormalizedStringparse(URL u)

Parses a XmlNormalizedString fragment from a URL.

public static XmlNormalizedStringparse(URL u, XmlOptions options)

Parses a XmlNormalizedString fragment from a URL.public stat


37/349


38/349

E>Reader r, XmlOptions options)

Parses a XmlNormalizedString fragment from a Reader.public static XmlNormalizedStringparse(Node node)

Parses a XmlNormalizedString fragment from a DOM Node.

public static XmlNormalizedStringparse(Node node, XmlOptions options) Parses a XmlNormalizedString fragment from a DOM Node.public static XmlNormalizedString

parse(XMLInputStream xis)

Parses a XmlNormalizedString fragment from an XMLInputStream.


39/349

public static XmlNormalizedStringparse(XMLInputStream xis, XmlOptions options)

Parses a XmlNormalizedString fragment from an XMLInputStream.

Methods from classjava.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail


40/349

newInstance() Methodpublic static XmlNormalizedString newInstance()Creates an empty instance of XmlNormalizedString
newInstance(XmlOptions) Methodpublic static XmlNormalizedString newInstance(XmlOptionsoptions)Creates an empty instance of XmlNormalizedString
newValidatingXMLInputStream(XMLInputStream) Method

throws XmlException, XMLStreamExceptionReturns a validating XMLInputStream. ExceptionsXmlExceptionXMLStreamException
newValidatingXMLInputStream(XMLInputStream, XmlOptions) Method

public static


41/349

/stream/XMLInputStream.html" target="_blank">XMLInputStream newValidatingXMLInputStream(XMLInputStreamxis,

XmlOptionsoptions)
newValue(Object) Methodpublic static XmlNormalizedString newValue(Objectobj)Creates an immutable XmlNormalizedString value
parse(String) Method
public static XmlNormalizedString parse(Strings)
throws XmlExceptionParses a XmlNormalizedStringfragment from a String. For example: " string to normalize ".
Exceptions
XmlExceptionparse(String, XmlOptions) Methodpublic static


42/349

edString.html')" target="_self">XmlNormalizedString parse(Strings,

XmlOptionsoptions)
throws XmlExceptionParses a XmlNormalizedStringfragment from a String. For example: " string to normalize ".
ExceptionsXmlExceptionparse(File) Methodpublic static XmlNormalizedString parse(Filef)
throws XmlException, IOExceptionParses a XmlNormalizedStringfragment from a File. ExceptionsXmlExceptionIOExceptionparse(File, XmlOptions) Methodpublic static XmlNormalizedString parse(Filef,
XmlOptionsoptions)
throws XmlException, IOExceptionParses a XmlNormalizedString


43/349

fragment from a File.
ExceptionsXmlExceptionIOExceptionparse(URL) Methodpublic static XmlNormalizedString parse(URLu)
throws XmlException, IOExceptionParses a XmlNormalizedStringfragment from a URL. ExceptionsXmlExceptionIOException
parse(URL, XmlOptions) Methodpublic static XmlNormalizedString parse(URLu,

XmlOptionsoptions)
throws XmlException, IOExceptionParses a XmlNormalizedStringfragment from a URL.


44/349

IOExceptionparse(InputStream) Methodpublic static XmlNormalizedString parse(InputStreamis)
throwsXmlException, IOExceptionParses a XmlNormalizedStringfragment from an InputStream.
ExceptionsXmlExceptionIOExceptionparse(InputStream, XmlOptions) Methodpublic static XmlNormalizedString parse(InputStreamis,XmlOptionsoptions)
throws XmlException, IOExceptionParses a XmlNormalizedStringfragment from an InputStream. Exceptions


45/349

parse(Reader) Methodpublic static XmlNormalizedString parse(Readerr)
throws XmlException, IOExceptionParses a XmlNormalizedStringfragment from a Reader.
parse(Reader, XmlOptions) Methodpublic static XmlNormalizedString parse(Readerr,XmlOptionsoptions)
throws XmlException, IOExceptionParses a XmlNormalizedStringfragment from a Reader.
parse(Node) Methodpublic static XmlNormalizedString parse(Nodenode)
throws


46/349

"javascript:reloadTOC('../../../com/bea/xml/XmlException.html')" target="_self">XmlExceptionParses a XmlNormalizedStringfragment from a DOM Node.
ExceptionsXmlExceptionparse(Node, XmlOptions) Methodpublic static XmlNormalizedString parse(Nodenode,
XmlOptionsoptions)
throws XmlExceptionParses a XmlNormalizedStringfragment from a DOM Node.

public static XmlNormalizedString parse(XMLInputStreamxis)
throws XmlException, XMLStreamException
Parses a XmlNormalizedStringfragment from an XMLInputStream.


47/349

XMLStreamExceptionparse(XMLInputStream, XmlOptions) Method

public static XmlNormalizedString parse(XMLInputStreamxis,
XmlOptionsoptions)
throws XmlException, XMLStreamExceptionParses a XmlNormalizedString

fragment from an XMLInputStream.
writeTopicInfo();

XmlNormalizedStringInterface displayInFrames();

com.bea.xml
XmlNormalizedString Interface


48/349

public interface XmlNormalizedString
extends XmlString

Corresponds to the XML Schemaxs:normalizedString type.One of the derived types based on xs:string.

An normalizedString simply is a string where all the carriage return,linefeed, and tab characters have been normalized (switched to) ordinaryspace characters. Use normalizedString for long strings to make theminsensitive to line breaking. If you wish to often be insensitive toruns of whitespace (as is often the case), usexs:token(aka XmlToken) instead.

Convertible to String. When obtaining the stringValue, the

whitespace-normalized value is returned.
All SuperinterfacesXmlAnySimpleType, XmlObject,XmlString, XmlTokenSource
All Known Subinterfaces
XmlENTITY, XmlID, XmlIDREF, XmlLanguage, XmlName, XmlNCName, XmlNMTOKEN, XmlToken


49/349

Nested Class Summarypublic static finalclassXmlNormalizedString.Factory

A classwith methods for creating instancesof XmlNormalizedString.

Nested classes from interfacecom.bea.xml.XmlAnySimpleTypeXmlAnySimpleType.Factory

Nested classes from interfacecom.bea.xml.XmlObjectXmlObject.FactoryNested classes from interfacecom.bea.xml.XmlStringXmlString.Factory


50/349

Field Summarypublic static finalSchemaTypetypeThe constant SchemaType object representing this schema type.





51/349

Fields from interfacecom.bea.xml.XmlStringtype

Method Summary


Methods from interfacecom.bea.xml.XmlObjectchangeType, compareTo, compareValue, copy


52/349

>, execQuery, execQuery, isImmutable, isNil, schemaType, selectPath, selectPath, set, setNil, toString, validate, validate, valueEquals, valueHashCode


documentProperties, monitor, newCursor, newDomNode, newDomNode, newInputStream, newInputStream, newReader, newReader, newXMLInputStream, newXMLInputStream, save,


53/349

ce.html#save(java.io.File)')" target="_self">save, save, save, save, save, save, save, xmlText, xmlText



writeTopicInfo();

XmlNOTATION.FactoryClass


54/349

displayInFrames();

com.bea.xml
XmlNOTATION.Factory Classpublic static final class XmlNOTATION.Factory
extends Object

A class with methods for creating instancesof XmlNOTATION.
Hierarchy
Object
XmlNOTATION.Factory
Enclosing interface
XmlNOTATION

Method Summarypublic static XmlNOTATIONnewInstance()

Creates an empty instance of XmlNOTATION


55/349

public static XmlNOTATIONnewInstance(XmlOptions options)

Creates an empty instance of XmlNOTATIONpublic static XMLInputStreamnewValidatingXMLInputStream(XMLInputStream xis)


public static XMLInputStreamnewValidatingXMLInputStream(XMLInputStream xis, XmlOptions options)

Returns a validating XMLInputStream.public static XmlNOTATION


56/349

newValue(Object obj)

Creates an immutable XmlNOTATION valuepublic static XmlNOTATIONparse(String s)

Parses a XmlNOTATION fragment from a String.public static XmlNOTATIONparse(String s, XmlOptions options)

Parses a XmlNOTATION fragment from a String.public static XmlNOTATIONparse(File f)

Parses a XmlNOTATION fragment from a File.


57/349

public static XmlNOTATIONparse(File f, XmlOptions options)

Parses a XmlNOTATION fragment from a File.public static XmlNOTATIONparse(URL u)

Parses a XmlNOTATION fragment from a URL.

public static XmlNOTATIONparse(URL u, XmlOptions options)

Parses a XmlNOTATION fragment from a URL.public static XmlNOTATION


58/349

parse(InputStream is)

Parses a XmlNOTATION fragment from an InputStream.public static XmlNOTATIONparse(InputStream is, XmlOptions options)

Parses a XmlNOTATION fragment from an InputStream.public static XmlNOTATION

parse(Reader r)

Parses a XmlNOTATION fragment from a Reader.public static XmlNOTATIONparse(Reader r, XmlOptions options)

Parses a


59/349

l')" target="_self">XmlNOTATION fragment from a Reader.public static XmlNOTATIONparse(Node node)

Parses a XmlNOTATION fragment from a DOM Node.public stat

ic XmlNOTATIONparse(Node node, XmlOptions options)

Parses a XmlNOTATION fragment from a DOM Node.

public static XmlNOTATIONparse(XMLInputStream xis)

Parses a XmlNOTATION fragment from an XMLInputStream.public static


60/349

t="_self">XmlNOTATIONparse(XMLInputStream xis, XmlOptions options)

Parses a XmlNOTATION fragment from an XMLInputStream.


Method DetailnewInstance() Methodpublic static


61/349

.html')" target="_self">XmlNOTATION newInstance()Creates an empty instance of XmlNOTATION
newInstance(XmlOptions) Methodpublic static XmlNOTATION newInstance(XmlOptionsoptions)Creates an empty instance of XmlNOTATIONnewValidatingXMLInputStream(XMLInputStream) Method

Exceptions
XmlExceptionXMLStreamExceptionnewValidatingXMLInputStream(XMLInputStream, XmlOptions) Method

public static XMLInputStream newValidatingXMLInputStream(XMLInputStreamxis,
XmlOptio


62/349

nsoptions)
ExceptionsXmlExceptionXMLStreamExceptionnewValue(Object) Methodpublic static XmlNOTATION newValue(Objectobj)Creates an immutable XmlNOTATION value parse(String) Methodpublic static XmlNOTATION parse(Strings)
throws XmlExceptio
nParses a XmlNOTATION fragment from aString.
parse(String, XmlOptions) Methodpublic static XmlNOTATION parse(Strings,

XmlOptionsoptions)
throws XmlException


63/349

Parses a XmlNOTATION fragment from aString.
ExceptionsXmlExceptionparse(File) Methodpublic static XmlNOTATION parse(Filef)
throws XmlException, IOExceptionParses a XmlNOTATION fragment from aFile.

parse(File, XmlOptions) Methodpublic static XmlNOTATION parse(Filef,

XmlOptionsoptions)
throws XmlException, IOExceptionParses a XmlNOTATION fragment from aFile.


64/349

target="_blank">IOExceptionparse(URL) Methodpublic static XmlNOTATION parse(URLu)
throws XmlException, IOExceptionParses a XmlNOTATION fragment from aURL.
IOExceptionparse(URL, XmlOptions) Methodpublic static XmlNOTATION parse(URLu,

XmlOptionsoptions)
throws XmlException, IOExceptionParses a XmlNOTATION fragment from aURL.
IOExceptionparse(InputStream) Method


65/349

public static XmlNOTATION parse(InputStreamis)
throws XmlException, IOExceptionParses a XmlNOTATION fragment from anInputStream.
ExceptionsXmlExceptionIOExceptionparse(InputStream, XmlOptions) Method
public static XmlNOTATION parse(InputStreamis,

XmlOptionsoptions)
throws XmlException, IOExceptionParses a XmlNOTATION fragment from an

InputStream.
parse(Reader) Methodpublic static XmlNOTATION parse(Readerr)


66/349

Parses a XmlNOTATION fragment from aReader.
ExceptionsXmlExceptionIOExceptionparse(Reader, XmlOptions) Methodpublic static XmlNOTATION parse(Readerr,
XmlOptionsoptions)
throws XmlException, IOExceptionParses a XmlNOTATION fragment from aReader.
IOExceptionparse(Node) Methodpublic static XmlNOTATION parse(Nodenode)
throws XmlExceptionParses a XmlNOTATION fragment from aDOM Node.


67/349

parse(Node, XmlOptions) Methodpublic static XmlNOTATION parse(Nodenode,

XmlOptionsoptions)
throws XmlExceptionParses a XmlNOTATION fragment from aDOM Node.

public static XmlNOTATION parse(XMLInputStreamxis)
throws XmlException, XMLStreamExceptionParses a XmlNOTATION fragment from anXMLInputStream. ExceptionsXmlExceptionXMLStreamExceptionparse(XMLInputStream, XmlOptions) Method


68/349

public static XmlNOTATION parse(XMLInputStreamxis,

XmlOptionsoptions)
throws XmlException, XMLStreamExceptionParses a XmlNOTATION fragment from anXMLInputStream.
writeTopicInfo();

XmlNOTATIONInterface displayInFrames();

com.bea.xml
XmlNOTATION Interfacepublic interface XmlNOTATION

extends XmlAnySimpleType

Corresponds to the XML Schemaxs:NOTATION type.

NOTATIONs are a mechanism in XML Schema that is provided


69/349

for partial backward compatibility with NOTATIONs in DTDs. XML Schemausers should almost never have any reason to use this data type.

Convertible to String.
All SuperinterfacesXmlAnySimpleType, XmlObject,XmlTokenSourceNested Class Summary
public static finalclassXmlNOTATION.Factory

A class

with methods for creating instancesof XmlNOTATION.Nested classes from interfacecom.bea.xml.XmlAnySimpleTypeXmlAnySimpleType.FactoryNested classes from interfacecom.bea.xml.XmlObject


70/349

XmlObject.Factory

Field Summarypublic static finalSchemaTypetype



Fields from interfacecom.bea.xml.XmlObjectEQUAL,


71/349

./../com/bea/xml/XmlObject.html#GREATER_THAN')" target="_self">GREATER_THAN, LESS_THAN, NOT_EQUAL, type

Method Summary


Methods from interfacecom.bea.xml.XmlObjectchangeType, compareTo, compareValue, copy, execQuery, execQuery, isImmutable,


72/349

./com/bea/xml/XmlObject.html#isNil()')" target="_self">isNil, schemaType, selectPath, selectPath, set, setNil, toString, validate, validate, valueEquals, valueHashCode

Methods from interfacecom.bea.xml.XmlTokenSourcedocumentProperties, monitor, newCursor, newDomNode, newDomNode, newInputStream, newInputStream, newReader, newReader, newXMLInputStream, newXMLInputStream, save, save, save, save,


73/349

om.bea.xml.XmlOptions)')" target="_self">save, save, save, save, xmlText, xmlText

Field Detail

typepublic static final SchemaType typeThe constant SchemaType object representing this schema type.

writeTopicInfo();

XmlObject.FactoryClass displayInFrames();

com.bea.xml
XmlObject.Factory Class


74/349

public static final class XmlObject.Factory
extends Object

Static factory class for creating new instances. Note that ifa type can be inferred from the XML being loaded (for example,by recognizing the document element QName), then the instancereturned by a factory will have the inferred type. Otherwisethe Factory will returned an untyped document.
Hierarchy
Object
XmlObject.Factory
Enclosing interface
XmlObject

Method Summarypublic static XmlObjectnewInstance()

Creates a new, completely empty instance.public static XmlObject


75/349

newInstance(XmlOptions options)

Creates a new, completely empty instance, specifying optionsfor the root element's document type and/or whether to validatevalue facets as they are set.public static XMLInputStreamnewValidatingXMLInputStream(XMLInputStreamxis)

Returns a new validating XMLInputStream that throws exceptions when the input is not valid.public static XMLInputStream

newValidatingXMLInputStream(XMLInputStream xis, XmlOptions options)

Returns a new validating XMLInputStream that throws exceptionswhen the input is not valid, specifying optionsfor the root element's document type and/or the collection object to use

as an error listener while validating.public static XmlObject


76/349

newValue(Object obj)

Creates an immutable XmlObject valuepublic static XmlSaxHandlernewXmlSaxHandler()

Returns an XmlSaxHandler that can load an XmlObject from SAX events.

public static XmlSaxHandlernewXmlSaxHandler(XmlOptions options)

Returns an XmlSaxHandler that can load an XmlObject from SAX events.public static XmlObjectparse(String s)

Parses the given String as XML.public static


77/349

"_self">XmlObjectparse(String s, XmlOptions options)

Parses the given String as XML.public static XmlObjectparse(File f)Parses the given File as XML.public static XmlObject

parse(File f, XmlOptions options)

Parses the given File as XML.public stat

ic XmlObjectparse(URL u)

Downloads the given URL as XML.


78/349

public static XmlObjectparse(URL u, XmlOptions options)

Downloads the given URL as XML.public static XmlObject

parse(InputStreamis)

Decodes and parses the given InputStream as XML.

public static XmlObjectparse(InputStream is, XmlOptions options)

Decodes and parses the given InputStream as XML.public stat


79/349

ic XmlObjectparse(Reader r)

Parses the given Reader as XML.public static XmlObjectparse(Reader r, XmlOptions options)

Parses the given Reader as XML.public static XmlObjectparse(Node node)

Converts the given DOM Node into an XmlObject.public static XmlObject

parse(Node node, XmlOptions options)

Converts the given DOM Node into an Xm


80/349

lObject.public static XmlObjectparse(XMLInputStream xis)

Loads the given XMLInputStream into an XmlObject.public static XmlObjectparse(XMLInputStream xis, XmlOptions options)

Loads the given XMLInputStream into an XmlObject.

Methods from classjava.lang.Object

clone, equals, finalize, getClass, hashCode, notify,


81/349

2se/1.4.2/docs/api/java/lang/Object.html#notifyAll()" target="_blank">notifyAll, toString, wait, wait, wait

Method DetailnewInstance() Methodpublic static XmlObject newInstance()Creates a new, completely empty instance.
newInstance(XmlOptions) Methodpublic static XmlObject newInstance(XmlOptionsoptions)
Creates a new, completely empty instance, specifying optionsfor the root element's document type and/or whether to validatevalue facets as they are set.

Use the options parameter to specify the following:
To specify thisUse this method The document type for the root element. XmlOptions.setDocumentType(SchemaType) Whether value facets should be checked as they are set.
XmlOptions.setValidateOnSet()
Parametersoptions


82/349

Options specifying root document type and/or value facetchecking. ReturnsA new, empty instance of XmlObject. newValidatingXMLInputStream(XMLInputStream) Method

throws XmlException, XMLStreamExceptionReturns a new validating XMLInputStream that throws exceptions when the input is not valid. ExceptionsXmlExceptionXMLStreamException
newValidatingXMLInputStream(XMLInputStream, XmlOptions) Method

public static XMLInputStream newValidatingXMLInputStream(XMLInputStream
xis,XmlOptionsoptions)
throws XmlException, XMLStreamExceptionReturns a new validating XMLInputStream


83/349

/CODE> that throws exceptionswhen the input is not valid, specifying optionsfor the root element's document type and/or the collection object to useas an error listener while validating.

Use the options parameter to specify the following:
A collection instance that should be used as an error listener duringcompilation, as described in XmlOptions.setErrorListener(Collection).The document type for the root element, as described inXmlOptions.setDocumentType(SchemaType). ParametersxisThe basis for the new XMLInputStream.
optionsOptions specifying root document type and/or an error listener. ReturnsA new validating XMLInputStream. Exceptions

XmlExceptionXMLStreamExceptionnewValue(Object) Methodpublic static XmlObject newValue(Objectobj)Creates an immutable XmlObject value
newXmlSaxHandler() Method


84/349

public static XmlSaxHandler newXmlSaxHandler()Returns an XmlSaxHandler that can load an XmlObject from SAX events.
newXmlSaxHandler(XmlOptions) Methodpublic static XmlSaxHandler newXmlSaxHandler(XmlOptionsoptions)Returns an XmlSaxHandler that can load an XmlObject from SAX events. parse(String) Methodpublic static XmlObject parse(Stri
ngs)
throws XmlExceptionParses the given String as XML.
parse(String, XmlOptions) Methodpublic static XmlObject parse(Strings,

XmlOptionsoptions)
throws XmlExceptionParses the given String as XML.Use the options parameter to specify the following:
To specify thisUse this method The document type for the root element. XmlOptions.setDocument


85/349

Type(SchemaType) To place line number annotations in the store when parsing a document. XmlOptions.setLoadLineNumbers() To replace the document element with the specified QName when parsing. XmlOptions.setLoadReplaceDocumentElement(QName) To strip all insignificant whitespace when parsing a document. XmlOptions.setLoadStripWhitespace() To strip all comments when parsing a document.

XmlOptions.setLoadStripComments() To strip all processing instructions when parsing a document. XmlOptions.setLoadStripProcinsts() A map of namespace URI substitutions to use when parsing a document. XmlOptions.setLoadSubstituteNamespaces(Map) Additional namespace mappings to be added when parsing a document. XmlOptions.setLoadAdditionalNamespaces(Map) To trim the underlying XML text buffer immediately after parsinga document, resulting in a smaller memory footprint.

XmlOptions.setLoadTrimTextBuffer()
ParameterssThe string to parse.


86/349

optionsOptions as specified. ReturnsA new instance containing the specified XML. ExceptionsXmlExceptionparse(File) Methodpublic static XmlObject parse(Filef)
throws XmlException, IOExceptionParses the given File as XML.
IOExceptionparse(File, XmlOptions) Methodpublic static XmlObject parse(Filef,

XmlOptionsoptions)
throws XmlException, IOExceptionParses the given File as XML.
Exceptions


87/349

XmlExceptionIOExceptionparse(URL) Methodpublic static XmlObject parse(URLu)
throws XmlException, IOExceptionDownloads the given URL as XML.
Exceptions
XmlExceptionIOExceptionparse(URL, XmlOptions) Method

public static XmlObject parse(URLu,

XmlOptionsoptions)
throws XmlException, IOExceptionDownloads the given URL as XML.
Exceptions


88/349

parse(InputStream) Methodpublic static XmlObject parse(InputStreamis)
throws XmlException, IOExceptionDecodes and parses the given InputStream as XML.
parse(InputStream, XmlOptions) Methodpublic static XmlObject parse(InputStreamis,

XmlOptionsoptions)
throws XmlException, IOExceptionDecodes and parses the given InputStream as XML.Use the options parameter to specify the following:
To specify thisUse this method The character encoding to use when parsing or writing a document. XmlOptions.setCharacterEncoding(String) The document type for the root element. XmlOptions.setDocumentType(SchemaType)


89/349

Place line number annotations in the store when parsing a document. XmlOptions.setLoadLineNumbers() Replace the document element with the specified QName when parsing. XmlOptions.setLoadReplaceDocumentElement(QName) Strip all insignificant whitespace when parsing a document. XmlOptions.setLoadStripWhitespace() Strip all comments when parsing a document. XmlOptions.setLoadStripComments()

Strip all processing instructions when parsing a document. XmlOptions.setLoadStripProcinsts() Set a map of namespace URI substitutions to use when parsing a document. XmlOptions.setLoadSubstituteNamespaces(Map)

Set additional namespace mappings to be added when parsing a document. XmlOptions.setLoadAdditionalNamespaces(Map) Trim the underlying XML text buffer immediately after parsinga document, resulting in a smaller memory footprint.

XmlOptions.setLoadTrimTextBuffer()


90/349

parse(Reader) Methodpublic static XmlObject parse(Readerr)
throws XmlException, IOExceptionParses the given Reader as XML.
ExceptionsXmlExceptionIOExceptionparse(Reader, XmlOptions) Methodpublic static XmlObject parse(Readerr,
XmlOptionso

ptions)
throws XmlException, IOExceptionParses the given Reader as XML.
IOExceptionparse(Node) Methodpublic static


91/349

tml')" target="_self">XmlObject parse(Nodenode)
throws XmlExceptionConverts the given DOM Node into anXmlObject.
ExceptionsXmlExceptionparse(Node, XmlOptions) Methodpublic static XmlObject parse(Nodenode,
XmlOptionsoptions)
throws XmlExceptionConverts the given DOM Node into anXmlObject.

public static XmlObject parse(XMLInputStreamxis)
throwsXmlException, XMLStreamExceptionLoads the given XMLInputStream into an XmlObject. ExceptionsXmlException


92/349

XMLStreamExceptionparse(XMLInputStream, XmlOptions) Method

public static XmlObject parse(XMLInputStreamxis,
XmlOptionsoptions)
throws XmlException, XMLStreamExceptionLoads the given XMLInputStream into an XmlObject.
writeTopicInfo();

XmlObjectInterface displayInFrames();

com.bea.xml


93/349

XmlObject Interfacepublic interface XmlObject
extends XmlTokenSource

Corresponds to the XML Schemaxs:anyType,the base type for all XML Beans.

Since all XML Schema types are translated into corresponding XML Beanclasses, and all Schema type derivation corresponds to Java classinheritance, the fact that all Schema types derive from xs:anyType meansthat all XML Bean classes derive from XmlObject.

On this base class you will find a number of common facilities thatall XML Bean classes provide:

Every XML Bean class has an inner Factory class for creating and parsing instances, including XmlObject. Use XmlObject.Factory itself to produce untyped XML trees or XML trees that implement specific subtypes of XmlObject depending on a recognized root document element. If you depend on the automatic type inference, you will want to understand the type inference issues described below.To write out an accurate XML file for the XML tree under this XmlObject, use one of the XmlObject.save(ContentHandler, LexicalHandler) methods, or XmlObject.newInputStream() or XmlObject.newReader(). Use XmlObject.toString() to produce a pretty-printed representation of the XML subtree under this XML Object. If you save interior portions of an XML document, you will want to understand the inner contents versus outer container issues described below.It is also simple to copy an XmlObject instance to or from a standard DOM tree or SAX stream. Use XmlObject.Factory.parse(Node), for example, to load from DOM; use Xm

lObject.Factory.newXmlSaxHandler() to load from SAX; use XmlObject.newDomNode() to save to DOM; and use

XmlObject.save(ContentHandler, LexicalHandler) to save to SAX.Use XmlObject.validate() to v


94/349

alidate the subtree of XML under this XML Object. If you wish to get information about the location and reason for validation errors, see XmlOptions.setErrorListener(Collection), and use XmlObject.validate(XmlOptions).Use XmlObject.newCursor() toaccess the full XML infoset, for example, if you need to determine interleaved element order or manipulate annotations, comments, or mixed content. See XmlCursor.Use XmlObject.selectPath(String) to find other XmlObjects in the subtree underneath this XmlObject using relative XPaths. (In selectPath, "." indicates the current element or attribute.)

Type inference. When using XmlObject.Factory to parse XML documents,the actual document type is not XmlObject.type itself, but a subtypebased on the contents of the parsed document. If the parsed documentcontains a recognized root document element, then the actual type of theloaded instance will be the matching Document type. For example:XmlObject xobj = XmlObject.Factory.parse(myDocument);if (xobj instanceof MyOrderDocument) // starts w/ { MyOrderDocument mydoc = (MyOrderDocument)xobj; if (!xobj.validate())

System.out.println("Not a valid my-order document");}else{ System.out.println("Not a my-order document");}Every XML Bean class has its own inner Factory class,so if you actually know exactly which XML Bean document typeyou want to load as in the example above, you should use thethe specific XML Bean Factory class instead. For example:MyOrderDocument mydoc = MyOrderDocument.Factory.parse(myDocument);

The code above will throw an exception if the parsed documentdoes not begin with the proper (my-order) element.

Inner versus outer. An XmlObject represents thecontents of an element or attribute, not the elementor attribute itself. So when you validate or save an XmlObject, youare validating or saving its contents, not its container. For example,if the XmlObject represents the contents of an element which happensto itself be in the wrong order relative to its siblings, validate will


95/349

not complain about the misplacement of the element itself. On the other hand,ifelements within the XmlObject are in the wrong order, validatewill complain. Similarly, when saving the contents of an interiorXmlObject, it is the contents of an element, not the element itself,which is saved by default.

Reading and writing fragments. When reading or writing the contents of awhole XML document, the standard XML reprentation for a document is used.However, there is no standard concrete XML representation for "just thecontents" of an interior element or attribute. So when one is needed,the tag is used to wrap the contents. This tag is usedcan also be used to load just the contents for an XmlObject document fragmentof arbitrary type. If you wish to save out the XmlObject's container elementalong with its contents, use XmlOptions.setSaveOuter().

Implementing XmlObject. The XMLBeans library does not support arbitraryimplementations of XmlObject - in almost all cases, you should only usethe implementations of XmlObject provided by the XMLBeans compiler itself.If you need to implement XmlObject yourself, you should subclassFilterXmlObject in order to delegate to another underlying XmlObjectimplementation. This technique will allow you to use your code unchanged

with future versions of XMLBeans that add additional methods on XmlObject.
All Known Implementing ClassesFilterXmlObject
All SuperinterfacesXmlTokenSourceAll Known Subinterfaces

SimpleValue, XmlAnySimpleType, XmlAnyURI, XmlBase64Binary, XmlBoolean, XmlByte, XmlDa


96/349

te, XmlDateTime, XmlDecimal, XmlDouble, XmlDuration, XmlENTITIES, XmlENTITY, XmlFloat, XmlGDay, XmlGMonth,XmlGMonthDay, XmlGYear, XmlGYearMonth, XmlHexBinary, XmlID, XmlIDREF, XmlIDREFS, XmlInt, XmlInteger, XmlLanguage, XmlLong, XmlName, XmlNCName, XmlNegativeInteger,XmlNMTOKEN, XmlNMTOKENS, XmlNonNegativeInteger, XmlNonPositiveInteger, XmlNormalizedString, XmlNOTATION, XmlPositiveInteger, XmlQName, XmlShort, XmlString, XmlTime, XmlToken, XmlUnsignedByte, XmlUnsignedInt, XmlUnsignedLong, XmlUnsignedShort


97/349

Nested Class Summarypublic static finalclassXmlObject.Factory

Static factory class for creating new instances.

Field Summarypublic static finalintEQUAL

EQUAL is 0. public static finalintGREATER_THAN

GREATER_THAN is 1. public static finalint


98/349

LESS_THANLESS_THAN is -1. public static finalintNOT_EQUALNOT_EQUAL is 2. public static finalSchemaType

typeThe constant SchemaType object representing this schema type.

Method Summarypublic XmlObjectchangeType(SchemaTypenewType)

Changes the schema type associated with this data andreturns a new XmlObject instance whose schemaType is the


99/349

new type.public intcompareTo(Object obj)

Impelements the Comparable interface by comparing two simplexml values based on their standard XML schema ordering.public int

compareValue(XmlObjectobj)

This comparison method is similar to compareTo, but ratherthan throwing a ClassCastException when two values are incomparable,it returns the number 2.

public XmlObjectcopy()

Returns a deep copy of this XmlObject.

public XmlObject[]execQuery(String query)


100/349

Executes a query. public XmlObject[]execQuery(String query, XmlOptions options)

Executes a query with options.

public booleanisImmutable()

True if the value is an immutable value. public bool

eanisNil()

True if the value is nil. public SchemaTypeschemaType()

The schema type for this instance.


101/349

public XmlObject[]selectPath(String path)

Selects a path. public XmlObject[]selectPath(St

ring path, XmlOptions options)

Selects a path, applying options.public XmlObject

set(XmlObject srcObj)

Set the value/type of this XmlObject to be a copy of the sourceXmlObject. public void

setNil()

Sets the value to nil. public


102/349

ref="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" target="_blank">StringtoString()

Returns an XML string for this XML object.public booleanvalidate()

Returns true if the contents of this object are validaccoring to schemaType().

public booleanvalidate(XmlOptions options)

Just like validate(), but with options.

public booleanvalueEquals(XmlObject obj)

True if the xml values are equal. public int


103/349

>valueHashCode()

Methods from interfacecom.bea.xml.XmlTokenSourcedocumentProperties, monitor, newCursor, newDomNode, newDomNode, newInputStream, newInputStream, newReader, newReader, newXMLInputStream, newXMLInputStream, save, save, save, save, save, save, save, save, xmlText, xmlText


104/349

Field DetailEQUALpublic static final int EQUALEQUAL is 0. See XmlObject.compareValue(XmlObject).
GREATER_THAN
public static final int GREATER_THANGREATER_THAN is 1. See XmlObject.compareValue(XmlObject).
LESS_THAN
public static final int LESS_THANLESS_THAN is -1. See XmlObject.compareValue(XmlObject).
NOT_EQUALpublic static final int NOT_EQUAL
NOT_EQUAL is 2. See XmlObject.compareValue(XmlObject).
type


105/349

public static final SchemaType typeThe constant SchemaType object representing this schema type.
Method DetailchangeType(SchemaType) Methodpublic XmlObject changeType(SchemaTypenewType)
Changes the schema type associated with this data andreturns a new XmlObject instance whose schemaType is thenew type.

Returns null if the type change is not allowed. Certaintype changes may be prohibited on the interior of an xmltree due to schema type system constraints (that is, dueto a parent container within which the newly specifiedtype is not permissible), but there are no constraintsat the roottype changes are neverprohibited at the root of an xml tree.

If the type change is allowed, then the new XmlObject should

be used rather than the old one. The old XmlObject instance andany other XmlObject instances in the subtree are permanentlyinvalidated and should not be used. (They will returnInvalidStateException if you try to use them.)

If a type change is done on the interior of an Xmltree, then xsi:type attributes are updated as needed.
compareTo(Object) Methodpublic int compareTo(Objectobj)Impelements the Comparable interface by comparing two simplexml values based on their standard XML schema ordering.Throws a ClassCastException if no standard ordering applies,or if the two values are incomparable within a partial order. compareValue(XmlObject) Methodpublic int compareValue(


106/349

a/xml/XmlObject.html')" target="_self">XmlObjectobj)This comparison method is similar to compareTo, but ratherthan throwing a ClassCastException when two values are incomparable,it returns the number 2. The result codes are -1 if this objectis less than obj, 1 if this object is greater than obj, zero ifthe objects are equal, and 2 if the objects are incomparable.
copy() Methodpublic XmlObject copy()Returns a deep copy of this XmlObject. The returned object has thesame type as the current object, and has all the content ofthe XML document underneath the current object. Note thatany parts of the XML document above or outside this XmlObject arenot copied. execQuery(String) Methodpublic XmlObject[] execQuery(Stringquery)Executes a query. Query can be a string or precompiled query String.
An XQuery is very similar to an XPath, except that it also permitsconstruction of new XML. As a result, the XmlObjects that arereturned from execQuery are in newly created documents, separatefrom the XmlObject on which the query is executed.

Syntax and usage is otherwise similar to selectPath.

Related Topics

XmlObject.selectPath(String)
execQuery(String, XmlOptions) Methodpublic XmlObject[] execQuery(Stringquery,
XmlOptionsoptions)Executes a query with options.Use the options parameter to specify the following:


107/349

To specify thisUse this method The document type for the root element. XmlOptions.setDocumentType(SchemaType) To replace the document element with the specified QName when constructingthe resulting document. XmlOptions.setLoadReplaceDocumentElement(QName) To strip all insignificant whitespace when constructing a document. XmlOptions.setLoadStripWhitespace() To strip all comments when constructing a document. XmlOptions.setLoadStripComments() To strip all processing instructions when constructing a document. XmlOptions.setLoadStripProcinsts() A map of namespace URI substitutions to use when constructing a document. XmlOptions.setLoadSubstituteNamespaces(Map) Additional namespace mappings to be added when constructing a document. XmlOptions.setLoadAdditionalNamespaces(Map) To trim the underlying XML text buffer immediately after constructinga document, resulting in a smaller memory footprint.

XmlOptions.setLoadTrimTextBuffer() Whether value facets should be checked as they are set. XmlOptions.setValidateOnSet()


108/349
ParametersqueryThe XQuery expression. optionsOptions as described.
Related Topics

XmlObject.execQuery(String)

isImmutable() Methodpublic boolean isImmutable()True if the value is an immutable value. Immutable values do nothave a position in a tree; rather, they are stand-alone simple typevalues. If the object is immutable, the equals() methods tests forvalue equality, and the object can be used as the key for a hash.
isNil() Methodpublic boolean isNil()
True if the value is nil. Note that in order to be nil,the value must be in an element, and the element containingthe value must be marked as nillable in the schema.
schemaType() Methodpublic SchemaType schemaType()The schema type for this instance. This is a permanent,unchanging property of the instance.
selectPath(String) Methodpublic XmlObject[] selectPath(Stringpath)Selects a path. Path can be a string or precompiled path String.

The path must be a relative path, where "." represents theelement or attribute containg this XmlObject, and it must select


109/349

only other elements or attributes. If a non-element or non-attributeis selected, an unchecked exception is thrown.

The array that is returned contains all the selectedXmlObjects, within the same document, listed in documentorder. The actual array type of the result is inferredfrom the closest common base type of selected results.

Here is an example of usage. Suppose we have a globalelement definition for "owner" whose type is "person": [...] and suppose "owner" tags can be scattered throughout thedocument. Then we can write the following code to findthem all:import org.openuri.sample.Person;import com.bea.xml.*;

[...] XmlObject xobj = XmlObject.Factory.parse(myFile); Person[] results; results = (Person[])xobj.selectPath( "declare namespace s='http://www.openuri.org/sample' " + ".//s:owner");Notice the way in which namespace declarations are done in XPath 2.0.Since XPath can only navigate within an XML document - it cannotconstruct new XML - the resulting XmlObjects all reside inthe same XML document as this XmlObject itself.

selectPath(String, XmlOptions) Methodpublic XmlObject[] selectPath(Stringpath,

XmlOptionsoptions)Selects a path, applying options.

Related Topics

XmlObject.selectPath(String)
set(XmlObject) Method


110/349

public XmlObject set(XmlObjectsrcObj)Set the value/type of this XmlObject to be a copy of the sourceXmlObject. Because the type of the source may be different than thistarget, this XmlObject may become defunct. In this case the newXmlObject is returned. If no type change happens, the same this will bereturned.
setNil() Methodpublic void setNil()Sets the value to nil. The element containing the value mustbe marked as nillable in the schema. toString() Methodpublic String toString()Returns an XML string for this XML object.
The string is pretty-printed. If you want a non-pretty-printedstring, or if you want to control options precisely, use thexmlText() methods.

Note that when producing XML any object other than very root of thedocument, then you are guaranteed to be looking at only a fragmentof XML, i.e., just the contents of an element or attribute, andand we will produce a string that starts with an tag.The XmlOptions.setSaveOuter() option on xmlText can be used to producethe actual element name above the object if you wish.

OverridesObject.toString()validate() Methodpublic boolean validate()Returns true if the contents of this object are valid

accoring to schemaType().

Does a deep validation of the entire subtree under theobject, but does not validate the parents or siblingsof the object if the object is in the interior of an xmltree.
validate(XmlOptions) Method


111/349

public boolean validate(XmlOptionsoptions)

Just like validate(), but with options.

If you wish to collect error messages and locations while validating,use the XmlOptions.setErrorListener(Collection) method. With that method,you can specify an object in which to store messages related to validation.The following is a simple example.
// Create an XmlOptions instance and set the error listener.XmlOptions validateOptions = new XmlOptions();ArrayList errorList = new ArrayList();validateOptions.setErrorListener(errorList);// Validate the XML.boolean isValid = newEmp.validate(validateOptions);// If the XML isn't valid, loop through the listener's contents,// printing contained messages.if (!isValid){
for (int i = 0; i < errorList.size(); i++) { XmlError error = (XmlError)errorList.get(i);

System.out.println("\n"); System.out.println("Message: " + error.getMessage() + "\n"); System.out.println("Location of invalid XML: " +

error.getCursorLocation().xmlText() + "\n"); }}
Parameters
optionsAn object that implements the Collection interface. valueEquals(XmlObject) Methodpublic boolean valueEquals(XmlObjectobj)True if the xml values are equal. Two different objects(which are distinguished by equals(obj) == false) may ofcourse have equal values (valueEquals(obj) == true).

Usually this method can be treated as an ordinary equvalencerelation, but actually it is not is not transitive.Here is a precise specification:

There are two categories of XML object: objects with a known


112/349

instance type, and objects whose only known type is one of theur-types (either AnyType or AnySimpleType). The first categoryis compared in terms of logical value spaces, and the secondcategory is compared lexically.

Within each of these two categories, valueEquals is a well-behavedequivalence relation. However, when comparing an object of knowntype with an object with ur-type, the comparison is done by attemptingto convert the lexical form of the ur-typed object into the othertype, and then comparing the results. Ur-typed objects are thereforetreated as lexical wildcards and may be equal to objects in differentvalue spaces, even though the objects in different value spaces arenot equal to each other.

For example, the anySimpleType value "1" will compare as anequalValue to the string "1", the float value "1.0", the doublevalue "1.0", the decimal "1", and the GYear "1", even thoughall these objects will compare unequal to each other since theylie in different value spaces.
valueHashCode() Methodpublic int valueHashCode()
writeTopicInfo();

XmlOptionsClass displayInFrames();

com.bea.xml
XmlOptions Class

public class XmlOptions
extends Object
implements Serializable

Used to supply options for loading, saving, and compiling, and validating.

There are two styles for using XmlOptions: multiline setup, and single-line use


113/349

.Here are two examples. First, multiline style:XmlOptions opts = new XmlOptions();opts.setSavePrettyPrint();opts.setSavePrettyPrintIndent(4);System.out.println(xobj.xmlText(opts));The alternative is single-line usage:System.out.println(xobj.xmlText( new XmlOptions().setSavePrettyPrint().setSavePrettyPrintIndent(4)));
Hierarchy
Object
XmlOptions
All Implemented Interfaces
Serializable

Field Summary

Constructor Summary


114/349

XmlOptions()
Construct a new blank XmlOptions.XmlOptions(XmlOptionsother)
Construct a new XmlOptions, copying the options.

Method Summarypublic Object

get(Object option)

Used to get a generic optionpublic boolean

hasOption(Object option)

Used to test a generic option


115/349

public static XmlOptionsmaskNull(XmlOptions o)

If passed null, returns an empty options object. public voidput(Object option)

Used to set a generic optionpublic voidput(Object option, Object value)Used to set a generic optionpublic voidput(Object option, int value)

Used to set a generic optionpublic static


116/349

t="_blank">ObjectsafeGet(XmlOptions o, Object option)

Used to test a generic option on an options object that may be nullpublic XmlOptionssetCharacterEncoding(String encoding)

When parsing or writing a document, this sets the characterencoding to use.public XmlOptionssetCompileDownloadUrls()

If this option is set, then the schema compiler will try to downloadschemas that appear in imports and includes from network based URLs.public XmlOptionssetCompileMdefNamespaces(Set mdefNamespaces)

If this option is set, then the schema compiler will permit andignore multiple definitions of the same component (element, attribute,type, etc) names in the given namespaces.


117/349

public XmlOptionssetCompileNoPvrRule()

If this option is set, the particle valid (restriciton) rule is notenforced when building a SchemaTypeSystem. public XmlOptionssetCompileNoUpaRule()

If this option is set, the unique particle attribution rule is not

enforced when building a SchemaTypeSystem. public XmlOptionssetCompileNoValidation()

If this option is set, validation is not done on the Schema XmlBeanswhen building a SchemaTypeSystempublic XmlOptionssetCompileSubstituteNames(Map nameMap)

This option allows for QName substitution during schema compilation.public


118/349

ref="javascript:reloadTOC('../../../com/bea/xml/XmlOptions.html')" target="_self">XmlOptionssetDocumentSourceName(String documentSourceName)

This option sets the document source name into the xml storewhen parsing a document. public XmlOptionssetDocumentType(SchemaType type)

When parsing a document, this sets the type of the rootelement. public XmlOptionssetEntityResolver(EntityResolver resolver)

If this option is set when compiling a schema, then the givenEntityResolver will be consulted in order to resolve anyURIs while downloading imported schemas.

public XmlOptionssetErrorListener(Collection c)


119/349

Sets a collection object for collecting XmlError objectsduring parsing, validation, and compilation. public XmlOptionssetLoadAdditionalNamespaces(Map nses)

Set additional namespace mappings to be added when parsinga document.

public XmlOptionssetLoadLineNumbers()

If this option is set, line number annotations are placedin the store when parsing a document.

public XmlOptionssetLoadMessageDigest()

If this option is set when loading from an InputStream or File, thenthe loader will compute a 160-bit SHA-1 message digest of the XMLfile while loading it and make it available viaXmlObject.documentProperties().getMessageDigest();

The schema compiler uses message digests to detect and eliminateduplicate imported xsd files.public XmlOptions


120/349

setLoadReplaceDocumentElement(QName replacement)

If this option is set, the document element is replaced with thegiven QName when parsing. public XmlOptionssetLoadStripComments()

If this option is set, all comments are stripped when parsinga document.

public XmlOptionssetLoadStripProcinsts()

If this option is set, all processing instructionsare stripped when parsing a document.

public XmlOptionssetLoadStripWhitespace()

If this option is set, all insignificant whitespace is stripped

when parsing a document. public XmlOptions


121/349

setLoadSubstituteNamespaces(Map substNamespaces)

This option sets a map of namespace uri substitutions that happenwhen parsing a document.public XmlOptionssetLoadTrimTextBuffer()

If this option is set, the underlying xml text buffer is trimmedimmediately after parsing a document resulting in a smaller memoryfootprint.

public XmlOptionssetSaveAggresiveNamespaces()

Causes the saver to reduce the number of namespace prefix declarations.

public XmlOptionssetSaveFilterProcinst(String filterProcinst)

This option causes the saver to filter a Processing Instructionwith the given targetpublic XmlOptions


122/349

setSaveImplicitNamespaces(Map implicitNamespaces)

If namespaces have already been declared outside the scope of thefragment being saved, this allows those mappings to be passeddown to the saver, so the prefixes are not re-declared.public XmlOptionssetSaveInner()

This option controls whether saving begins on the element or its contents

public XmlOptionssetSaveNamespacesFirst()

This option will cause the saver to save namespace attributes first.

public XmlOptionssetSaveOuter()

This option controls whether saving begins on the element or its contentspublic XmlOptions


123/349

setSavePrettyPrint()

This option will cause the saver to reformat white space for easier reading.public XmlOptionssetSavePrettyPrintIndent(int indent)

When used with setSavePrettyPrint this sets the indentamount to use.public XmlOptionssetSavePrettyPrintOffset(int offset)

When used with setSavePrettyPrint this sets the offsetamount to use.

public XmlOptionssetSaveSuggestedPrefixes(Map suggestedPrefixes)

A map of hints to pass to the saver for which prefixes to usefor which namespace URI.

public XmlOptionssetSaveSyntheticDocumentElement


124/349

de>(QName name)

This option causes the saver to wrap the current fragment inan element with the given name.public XmlOptionssetSaveUseOpenFrag()

When saving a fragment, this option changes the qname of the synthesizedroot element. public XmlOptionssetUseDefaultNamespace()

If this option is set, the saver will try to use the defaultnamespace for the most commonly used URI.

public XmlOptionssetValidateOnSet()

If this option is set when an instance is created, then valuefacets will be checked on each call to a setter or gettermethod on instances of XmlObject within the instance document.

public XmlOptionssetXqueryCurrentNodeVar(


125/349

://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" target="_blank">String varName)

Sets the name of the variable that representsthe current node in a query expression.public XmlOptionssetXqueryVariables(MapvarMap)

Map the names and values of external variables in an xqueryexpression.



126/349

Field DetailConstructor DetailXmlOptionspublic XmlOptions()Construct a new blank XmlOptions.XmlOptions

public XmlOptions(XmlOptionsother)Construct a new XmlOptions, copying the options.Method Detail

get(Object) Methodpublic Object get(Objectoption)Used to get a generic option
hasOption(Object) Method
public boolean hasOption(Objectoption)Used to test a generic option
maskNull(XmlOptions) Methodpublic static XmlOptions maskNull(


127/349

script:reloadTOC('../../../com/bea/xml/XmlOptions.html')" target="_self">XmlOptionso)If passed null, returns an empty options object. Otherwise, returns its argument.
put(Object) Methodpublic void put(Objectoption)Used to set a generic option put(Object, Object) Methodpublic void put(Objectoption,
Objectvalue)Used to set a generic option

put(Object, int) Methodpublic void put(Objectoption,

intvalue)Used to set a generic option
safeGet(XmlOptions, Object) Methodpublic static Object safeGet(XmlOptionso,Objectoption)Used to test a generic option on an options object that may be null setCharacterEncoding(String) Methodpublic XmlOptions setCharacterEncoding(Stringencoding)When parsing or writing a document, this sets the characterencoding to use. Parametersencodingthe character encoding


128/349

Related Topics

XmlObject.Factory.parse(File, XmlOptions)
XmlTokenSource.save(File, XmlOptions)
setCompileDownloadUrls() Methodpublic XmlOptions setCompileDownloadUrls()If this option is set, then the schema compiler will try to downloadschemas that appear in imports and includes from network based URLs.
Related Topics

XmlBeans.compileXsd(XmlObject[], SchemaTypeLoader, XmlOptions)
setCompileMdefNamespaces(Set) Methodpublic XmlOptions setCompileMdefNamespaces(SetmdefNamespaces)If this option is set, then the schema compiler will permit andignore multiple definitions of the same component (element, attribute,type, etc) names in the given namespaces. If multiple definitionswith the same name appear, the definitions that happen to be processedlast will be ignored. ParametersmdefNamespaces
a set of namespace URIs as Strings

Related Topics



129/349

setCompileNoPvrRule() Methodpublic XmlOptions setCompileNoPvrRule()If this option is set, the particle valid (restriciton) rule is notenforced when building a SchemaTypeSystem. SeeSection 3.9.6 of the XML Schema specificationfor information on the PVR rule.
Related Topics


setCompileNoUpaRule() Methodpublic XmlOptions setCompileNoUpaRule()If this option is set, the unique particle attribution rule is notenforced when building a SchemaTypeSystem. SeeAppendixH of the XML Schema specificationfor information on the UPA rule.

Related Topics

setCompileNoValidation() Methodpublic XmlOptions setCompileNoValidation()
If this option is set, validation is not done on the Schema XmlBeanswhen building a SchemaTypeSystem

Related Topics



130/349

setCompileSubstituteNames(Map) Methodpublic XmlOptions setCompileSubstituteNames(MapnameMap)This option allows for QName substitution during schema compilation. ParametersnameMapa map from QNames to substitute QNames.
Related Topics

setDocumentSourceName(String) Methodpublic XmlOptions setDocumentSourceName(StringdocumentSourceName)
This option sets the document source name into the xml storewhen parsing a document. If a document is parsed from aFile or URI, it is automatically set to the URI of thesource; otherwise, for example, when parsing a String,you can use this option to specify the source name yourself.

Related Topics

XmlObject.Factory.parse(String, XmlOptions)
setDocumentType(SchemaType) Methodpublic XmlOptions setDocumentType(SchemaTypetype)When parsing a document, this sets the type of the root


131/349

element. If this is set, the parser will not try to guessthe type based on the document's QName.
ParameterstypeThe root element's document type.
Related Topics

setEntityResolver(EntityResolver) Methodpublic XmlOptions setEntityResolver(EntityResolverresolver)If this option is set when compiling a schema, then the givenEntityResolver will be consulted in order to resolve anyURIs while downloading imported schemas.
EntityResolvers are currently only used by compileXsd; theyare not consulted by other functions, for example, parse.This will likely change in the future.

Related Topics

setErrorListener(Collection) Methodpublic XmlOptions setErrorListener(
Collectionc)

Sets a collection object for collecting XmlError objectsduring parsing, validation, and compilation. When set, the collectionwill contain all the errors after the operation takes place. Notice thatthe errors will only have line numbers if the document wasloaded with line numbers enabled.

The following simple example illustrates using an error listener


132/349

during validation.
// Create an XmlOptions instance and set the error listener.XmlOptions validateOptions = new XmlOptions();ArrayList errorList = new ArrayList();validateOptions.setErrorListener(errorList);// Validate the XML.boolean isValid = newEmp.validate(validateOptions);// If the XML isn't valid, loop through the listener's contents,// printing contained messages.if (!isValid){ for (int i = 0; i < errorList.size(); i++) { XmlError error = (XmlError)errorList.get(i);
System.out.println("\n"); System.out.println("Message: " + error.getMessage() + "\n"); System.out.println("Location of invalid XML: " +

error.getCursorLocation().xmlText() + "\n"); }

}
ParameterscA collection that will be filled with XmlError objectsvia Collection.add(Object)
Related Topics

XmlError

XmlObject.validate(XmlOptions)


133/349

dLineNumbers()')" target="_self">XmlOptions.setLoadLineNumbers()
setLoadAdditionalNamespaces(Map) Methodpublic XmlOptions setLoadAdditionalNamespaces(Mapnses)Set additional namespace mappings to be added when parsinga document. Parametersnsesadditional namespace mappings
Related Topics

setLoadLineNumbers() Methodpublic XmlOptions setLoadLineNumbers()If this option is set, line number annotations are placed
in the store when parsing a document. This is particularlyuseful when you want XmlError objects to containline numbers.

Related Topics


XmlError
setLoadMessageDigest() Methodpublic XmlOptions setLoadMessageDigest()


134/349

If this option is set when loading from an InputStream or File, thenthe loader will compute a 160-bit SHA-1 message digest of the XMLfile while loading it and make it available viaXmlObject.documentProperties().getMessageDigest();
The schema compiler uses message digests to detect and eliminateduplicate imported xsd files.

Related Topics

setLoadReplaceDocumentElement(QName) Methodpublic XmlOptions setLoadReplaceDocumentElement(QNamereplacement)
If this option is set, the document element is replaced with thegiven QName when parsing. If null is supplied, the document elementis removed.

Related Topics


setLoadStripComments() Methodpublic XmlOptions setLoadStripComments()If this option is set, all comments are stripped when parsinga document.

Related Topics

XmlObject.F

actory.parse(File, XmlOptions)
setLoadStripProcinsts() Methodpublic XmlOptions setLoadStripProcinsts()If this option is set, all processing instructions


135/349

are stripped when parsing a document.

Related Topics

setLoadStripWhitespace() Methodpublic XmlOptions setLoadStripWhitespace()If this option is set, all insignificant whitespace is strippedwhen parsing a document. Can be used to save memory on largedocuments when you know there is no mixed content.
Related Topics

setLoadSubstituteNamespaces(Map) Methodpublic XmlOptions setLoadSubstituteNamespaces(MapsubstNamespaces)This option sets a map of namespace uri substit

Documents

03 LTE Radio Parameters System Info v20