com.bea.xml
FilterXmlObject Class

public abstract class FilterXmlObject

    extends Object
    implements SimpleValue, XmlObject

A FilterXmlObject delegates to some other XmlObject, which it can use as its basic source of data, possibly transforming the data along the way or providing additional functionality. The class FilterXmlObject itself simply overrides all methods of XmlObject with versions that pass all requests to the underlying XmlObject. Subclasses of FilterXmlObject may further override some of these methods and may also provide additional methods and fields.

Note: it is important that FilterXmlOBject has no storage (i.e., no non-transient fields), because subclasses may be serializable and adding storage would break the serialization format.

Hierarchy

Object
  FilterXmlObject

All Implemented Interfaces

SimpleValue, XmlObject, XmlTokenSource

FilterXmlObject

public FilterXmlObject()

bigDecimalValue() Method

public BigDecimal bigDecimalValue()

bigIntegerValue() Method

public BigInteger bigIntegerValue()

booleanValue() Method

public boolean booleanValue()

byteArrayValue() Method

public byte[] byteArrayValue()

byteValue() Method

public byte byteValue()

calendarValue() Method

public Calendar calendarValue()

changeType(SchemaType) Method

public XmlObject changeType(SchemaType newType)

Returns null if the type change is not allowed. Certain type changes may be prohibited on the interior of an xml tree due to schema type system constraints (that is, due to a parent container within which the newly specified type is not permissible), but there are no constraints at the roottype changes are never prohibited 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 and any other XmlObject instances in the subtree are permanently invalidated and should not be used. (They will return InvalidStateException if you try to use them.) If a type change is done on the interior of an Xml tree, then xsi:type attributes are updated as needed.

compareTo(Object) Method

public int compareTo(Object obj)

compareValue(XmlObject) Method

public int compareValue(XmlObject obj)

copy() Method

public XmlObject copy()

dateValue() Method

public Date dateValue()

documentProperties() Method

public XmlDocumentProperties documentProperties()

doubleValue() Method

public double doubleValue()

enumValue() Method

public StringEnumAbstractBase enumValue()

execQuery(String) Method

public XmlObject[] execQuery(String query)

An XQuery is very similar to an XPath, except that it also permits construction of new XML. As a result, the XmlObjects that are returned from execQuery are in newly created documents, separate from the XmlObject on which the query is executed.

Syntax and usage is otherwise similar to selectPath.

execQuery(String, XmlOptions) Method

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

Parameters

query

The XQuery expression.

options

Options as described.

floatValue() Method

public float floatValue()

gDateValue() Method

public GDate gDateValue()

gDurationValue() Method

public GDuration gDurationValue()

getBigDecimalValue() Method

public BigDecimal getBigDecimalValue()

getBigIntegerValue() Method

public BigInteger getBigIntegerValue()

getBooleanValue() Method

public boolean getBooleanValue()

getByteArrayValue() Method

public byte[] getByteArrayValue()

getByteValue() Method

public byte getByteValue()

getCalendarValue() Method

public Calendar getCalendarValue()

getDateValue() Method

public Date getDateValue()

getDoubleValue() Method

public double getDoubleValue()

getEnumValue() Method

public StringEnumAbstractBase getEnumValue()

getFloatValue() Method

public float getFloatValue()

getGDateValue() Method

public GDate getGDateValue()

getGDurationValue() Method

public GDuration getGDurationValue()

getIntValue() Method

public int getIntValue()

getListValue() Method

public List getListValue()

getLongValue() Method

public long getLongValue()

getObjectValue() Method

public Object getObjectValue()

getQNameValue() Method

public QName getQNameValue()

getShortValue() Method

public short getShortValue()

getStringValue() Method

public String getStringValue()

instanceType() Method

public SchemaType instanceType()

For unions, this returns the non-union consituent type of this instance. This type may change if setters are called that cause the instance to change to another constituent type of the union.

For nil values, this returns null.

intValue() Method

public int intValue()

isImmutable() Method

public boolean isImmutable()

isNil() Method

public boolean isNil()

listValue() Method

public List listValue()

longValue() Method

public long longValue()

monitor() Method

public Object monitor()

newCursor() Method

public XmlCursor newCursor()

newDomNode() Method

public Node newDomNode()

newDomNode(XmlOptions) Method

public Node newDomNode(XmlOptions options)

newInputStream() Method

public InputStream newInputStream()

newInputStream(XmlOptions) Method

public InputStream newInputStream(XmlOptions options)

newReader() Method

public Reader newReader()

newReader(XmlOptions) Method

public Reader newReader(XmlOptions options)

newXMLInputStream() Method

DEPRECATED Superceded by JSR 173

public XMLInputStream newXMLInputStream()

newXMLInputStream(XmlOptions) Method

DEPRECATED Superceded by JSR 173

public XMLInputStream newXMLInputStream(XmlOptions options)

Just like newXMLInputStream() but with any of a number of options. Use the options parameter to specify the following:

Parameters

options

Any of the described options.

Returns

A new validating XMLInputStream.

objectSet(Object) Method

public void objectSet(Object obj)

objectValue() Method

public Object objectValue()

qNameValue() Method

public QName qNameValue()

save(ContentHandler, LexicalHandler) Method

public void save(ContentHandler ch, 
                 LexicalHandler lh)
     throws SAXException

Exceptions

SAXException

save(File) Method

public void save(File file)
     throws IOException

Exceptions

IOException

save(OutputStream) Method

public void save(OutputStream os)
     throws IOException

Exceptions

IOException

save(Writer) Method

public void save(Writer w)
     throws IOException

Exceptions

IOException

save(ContentHandler, LexicalHandler, XmlOptions) Method

public void save(ContentHandler ch, 
                 LexicalHandler lh, 
                 XmlOptions options)
     throws SAXException

Exceptions

SAXException

save(File, XmlOptions) Method

public void save(File file, 
                 XmlOptions options)
     throws IOException

Exceptions

IOException

save(OutputStream, XmlOptions) Method

public void save(OutputStream os, 
                 XmlOptions options)
     throws IOException

Exceptions

IOException

save(Writer, XmlOptions) Method

public void save(Writer w, 
                 XmlOptions options)
     throws IOException

Exceptions

IOException

schemaType() Method

public SchemaType schemaType()

selectPath(String) Method

public XmlObject[] selectPath(String path)

The path must be a relative path, where "." represents the element or attribute containg this XmlObject, and it must select only other elements or attributes. If a non-element or non-attribute is selected, an unchecked exception is thrown.

The array that is returned contains all the selected XmlObjects, within the same document, listed in document order. The actual array type of the result is inferred from the closest common base type of selected results.

Here is an example of usage. Suppose we have a global element definition for "owner" whose type is "person":

   <schema targetNamespace="http://openuri.org/sample">
      <element name="owner" type="person"/>
      <complexType name="person">
         [...]
      </complexType>
   </schema>
 

 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");
 

selectPath(String, XmlOptions) Method

public XmlObject[] selectPath(String path, 
                            XmlOptions options)

set(XmlObject) Method

public XmlObject set(XmlObject srcObj)

set(String) Method

public void set(String obj)

set(boolean) Method

public void set(boolean v)

set(byte) Method

public void set(byte v)

set(short) Method

public void set(short v)

set(int) Method

public void set(int v)

set(long) Method

public void set(long v)

set(BigInteger) Method

public void set(BigInteger obj)

set(BigDecimal) Method

public void set(BigDecimal obj)

set(float) Method

public void set(float v)

set(double) Method

public void set(double v)

set(byte[]) Method

public void set(byte[] obj)

set(StringEnumAbstractBase) Method

public void set(StringEnumAbstractBase obj)

set(Calendar) Method

public void set(Calendar obj)

set(Date) Method

public void set(Date obj)

set(GDateSpecification) Method

public void set(GDateSpecification obj)

set(GDurationSpecification) Method

public void set(GDurationSpecification obj)

set(QName) Method

public void set(QName obj)

set(List) Method

public void set(List obj)

setBigDecimalValue(BigDecimal) Method

public void setBigDecimalValue(BigDecimal obj)

setBigIntegerValue(BigInteger) Method

public void setBigIntegerValue(BigInteger obj)

setBooleanValue(boolean) Method

public void setBooleanValue(boolean v)

setByteArrayValue(byte[]) Method

public void setByteArrayValue(byte[] obj)

setByteValue(byte) Method

public void setByteValue(byte v)

setCalendarValue(Calendar) Method

public void setCalendarValue(Calendar obj)

setDateValue(Date) Method

public void setDateValue(Date obj)

setDoubleValue(double) Method

public void setDoubleValue(double v)

setEnumValue(StringEnumAbstractBase) Method

public void setEnumValue(StringEnumAbstractBase obj)

setFloatValue(float) Method

public void setFloatValue(float v)

setGDateValue(GDate) Method

public void setGDateValue(GDate obj)

setGDurationValue(GDuration) Method

public void setGDurationValue(GDuration obj)

setIntValue(int) Method

public void setIntValue(int v)

setListValue(List) Method

public void setListValue(List obj)

setLongValue(long) Method

public void setLongValue(long v)

setNil() Method

public void setNil()

setObjectValue(Object) Method

public void setObjectValue(Object obj)

setQNameValue(QName) Method

public void setQNameValue(QName obj)

setShortValue(short) Method

public void setShortValue(short v)

setStringValue(String) Method

public void setStringValue(String obj)

shortValue() Method

public short shortValue()

stringValue() Method

public String stringValue()

underlyingXmlObject() Method

public abstract XmlObject underlyingXmlObject()

Every other method of this class delegates to the object returned from this method. It is assumed that the object implements all the methods of both XmlObject and SimpleValue.

validate() Method

public boolean validate()

Does a deep validation of the entire subtree under the object, but does not validate the parents or siblings of the object if the object is in the interior of an xml tree.

validate(XmlOptions) Method

public boolean validate(XmlOptions options)

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

options

An object that implements the Collection interface.

valueEquals(XmlObject) Method

public boolean valueEquals(XmlObject obj)

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

There are two categories of XML object: objects with a known instance type, and objects whose only known type is one of the ur-types (either AnyType or AnySimpleType). The first category is compared in terms of logical value spaces, and the second category is compared lexically.

Within each of these two categories, valueEquals is a well-behaved equivalence relation. However, when comparing an object of known type with an object with ur-type, the comparison is done by attempting to convert the lexical form of the ur-typed object into the other type, and then comparing the results. Ur-typed objects are therefore treated as lexical wildcards and may be equal to objects in different value spaces, even though the objects in different value spaces are not equal to each other.

For example, the anySimpleType value "1" will compare as an equalValue to the string "1", the float value "1.0", the double value "1.0", the decimal "1", and the GYear "1", even though all these objects will compare unequal to each other since they lie in different value spaces.

valueHashCode() Method

public int valueHashCode()

xgetListValue() Method

public List xgetListValue()

xlistValue() Method

public List xlistValue()

xmlText() Method

public String xmlText()

xmlText(XmlOptions) Method

public String xmlText(XmlOptions options)