Home » xmlbeans-2.5.0-src » org.apache.xmlbeans.impl » values » [javadoc | source]
org.apache.xmlbeans.impl.values
abstract public class: XmlObjectBase [javadoc | source]
java.lang.Object
   org.apache.xmlbeans.impl.values.XmlObjectBase

All Implemented Interfaces:
    TypeStoreUser, Serializable, SimpleValue, XmlObject

Field Summary
public static final  short MAJOR_VERSION_NUMBER     
public static final  short MINOR_VERSION_NUMBER     
public static final  short KIND_SETTERHELPER_SINGLETON     
public static final  short KIND_SETTERHELPER_ARRAYITEM     
public static final  ValidationContext _voorVc     
Constructor:
 protected XmlObjectBase() 
Method from org.apache.xmlbeans.impl.values.XmlObjectBase Summary:
_copy,   _copy,   _isComplexContent,   _isComplexType,   _set,   _validateOnSet,   attach_store,   bigDecimalValue,   bigIntegerValue,   booleanValue,   buildInnerPrettyOptions,   build_nil,   build_text,   byteArrayValue,   byteValue,   calendarValue,   changeType,   check_dated,   check_orphaned,   compareTo,   compareValue,   compare_to,   compute_text,   copy,   create_attribute_user,   create_element_user,   dateValue,   disconnect_store,   documentProperties,   doubleValue,   dump,   elementFlags,   enumValue,   equal_to,   equals,   execQuery,   execQuery,   floatValue,   gDateValue,   gDurationValue,   generatedSetterHelperImpl,   getBigDecimalValue,   getBigIntegerValue,   getBooleanValue,   getByteArrayValue,   getByteValue,   getCalendarValue,   getDateValue,   getDomNode,   getDoubleValue,   getEnumValue,   getFloatValue,   getGDateValue,   getGDurationValue,   getIntValue,   getListValue,   getLongValue,   getObjectValue,   getQNameValue,   getShortValue,   getStringValue,   getXmlLocale,   get_attribute_field,   get_attribute_type,   get_attributeflags,   get_default_attribute_text,   get_default_attribute_value,   get_default_element_text,   get_element_ending_delimiters,   get_element_type,   get_elementflags,   get_schema_type,   get_store,   get_wscanon_rule,   get_wscanon_text,   has_store,   hashCode,   initComplexType,   init_flags,   instanceType,   intValue,   invalidate_element_order,   invalidate_nilvalue,   invalidate_value,   isDefault,   isDefaultable,   isFixed,   isImmutable,   isInstanceOf,   isNil,   isNillable,   is_child_element_order_sensitive,   is_defaultable_ws,   is_orphaned,   java_value,   listValue,   longValue,   monitor,   newCursor,   newCursorForce,   newDomNode,   newDomNode,   newInputStream,   newInputStream,   newReader,   newReader,   newXMLInputStream,   newXMLInputStream,   newXMLStreamReader,   newXMLStreamReader,   new_visitor,   objectSet,   objectValue,   qNameValue,   save,   save,   save,   save,   save,   save,   save,   save,   schemaType,   selectAttribute,   selectAttribute,   selectAttributes,   selectChildren,   selectChildren,   selectChildren,   selectPath,   selectPath,   set,   set,   set,   set,   set,   set,   set,   set,   set,   set,   set,   set,   set,   set,   set,   set,   set,   set,   set,   setBigDecimalValue,   setBigIntegerValue,   setBooleanValue,   setByteArrayValue,   setByteValue,   setCalendarValue,   setDateValue,   setDoubleValue,   setEnumValue,   setFloatValue,   setGDateValue,   setGDateValue,   setGDurationValue,   setGDurationValue,   setImmutable,   setIntValue,   setListValue,   setLongValue,   setNil,   setObjectValue,   setQNameValue,   setShortValue,   setStringValue,   setValidateOnSet,   set_BigDecimal,   set_BigInteger,   set_ByteArray,   set_Calendar,   set_ComplexXml,   set_Date,   set_GDate,   set_GDuration,   set_QName,   set_String,   set_b64,   set_boolean,   set_byte,   set_char,   set_double,   set_enum,   set_float,   set_hex,   set_int,   set_list,   set_long,   set_newValue,   set_nil,   set_notation,   set_short,   set_text,   set_xmlanysimple,   shortValue,   stringValue,   substitute,   toString,   update_from_complex_content,   uses_invalidate_value,   validate,   validate,   validate_now,   validate_simpleval,   valueEquals,   valueHashCode,   value_hash_code,   writeReplace,   xgetListValue,   xlistValue,   xmlText,   xmlText
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.xmlbeans.impl.values.XmlObjectBase Detail:
 public final XmlObject _copy() 
    Same as copy() but unsynchronized. Warning: Using this method in mutithreaded environment can cause invalid states.
 public final XmlObject _copy(XmlOptions xmlOptions) 
    Same as copy() but unsynchronized. If Locale.COPY_USE_NEW_LOCALE is set in the options, a new locale will be created for the copy. Warning: Using this method in mutithreaded environment can cause invalid states.
 protected boolean _isComplexContent() 
 protected boolean _isComplexType() 
 public final XmlObject _set(XmlObject src) 
    Same as set() but unsynchronized. Warning: Using this method in mutithreaded environment can cause invalid states.
 protected boolean _validateOnSet() 
 public final  void attach_store(TypeStore store) 
    Called to initialize the TypeStore associated with this XmlObject implementation. If not called, this is a free-floating value holder. When a value is first attached, it is put in a completely invalidated state.
 public BigDecimal bigDecimalValue() 
Deprecated! replaced - with #getBigDecimalValue

 public BigInteger bigIntegerValue() 
Deprecated! replaced - with #getBigIntegerValue

 public boolean booleanValue() 
Deprecated! replaced - with #getBooleanValue

 static final XmlOptions buildInnerPrettyOptions() 
 public boolean build_nil() 
    A store will call back on build_nil after we've called invalidate_nil and it needs to know what the nil value is.
 public final String build_text(NamespaceManager nsm) 
    Called by a TypeStore to pull out the most reasonable text value from us. This is done after we have invalidated the store (typically when our value has been set).
 public byte[] byteArrayValue() 
Deprecated! replaced - with #getByteArrayValue

 public byte byteValue() 
Deprecated! replaced - with #getByteValue

 public Calendar calendarValue() 
Deprecated! replaced - with #getCalendarValue

 public XmlObject changeType(SchemaType type) 
 public final  void check_dated() 
    Called prior to every get operation, to ensure that the value being read is valid. If the value has been invalidated, it is re-read from the underlying text store, and this may cause an out of range exception. This method deals with nils, nillability, defaults, etc.
 protected final  void check_orphaned() 
    Called before every getter and setter on the strongly typed classes to ensure that the object has not been orphaned.
 public final int compareTo(Object obj) 
    Implements Comparable. This compareTo is inconsistent with equals unless isImmutable() is true.
 public final int compareValue(XmlObject xmlobj) 
 protected int compare_to(XmlObject xmlobj) 
    This implementation of compare_to is allowed to do two unusual things: (1) it can assume that the xmlobj passed has a primitive type underlying the instance type that matches the current instance, and that neither is nil. (2) it is allowed to return 2 for "incomparable"; it should not throw an exception.
 abstract protected String compute_text(NamespaceManager nsm)
    This should return the canonical string value of the primitive. Only called when non-nil.
 public final XmlObject copy() 
 public TypeStoreUser create_attribute_user(QName attrName) 
    A typestore user can create a new TypeStoreUser instance for a given attribute child, based on the attribute name. Returns null if there is no strongly typed information for that given attributes.
 public TypeStoreUser create_element_user(QName eltName,
    QName xsiType) 
    A typestore user can create a new TypeStoreUser instance for a given element child name as long as you also pass the qname contained by the xsi:type attribute, if any. Note that we will ignore the xsiType if it turns out to be invalid. Returns null if there is no strongly typed information for that given element (which implies, recusively, no strongly typed information downwards).
 public Date dateValue() 
Deprecated! replaced - with #getDateValue

 public  void disconnect_store() 
    A store calls back here in order to force a disconnect. After this is done, the object should be considered invalid. Any attempt to access or set a value should result in an exception. Note that this is how we handle deletions and xsi:type changes.
 public XmlDocumentProperties documentProperties() 
 public double doubleValue() 
Deprecated! replaced - with #getDoubleValue

 public  void dump() 
 protected int elementFlags() 
    Used for situations where these flags must be passed on to chained values. (See XmlAnySimpleType (allSimpleValue), union implementations).
 public StringEnumAbstractBase enumValue() 
Deprecated! replaced - with #getEnumValue

 abstract protected boolean equal_to(XmlObject xmlobj)
 public final boolean equals(Object obj) 
 public XmlObject[] execQuery(String path) 
 public XmlObject[] execQuery(String queryExpr,
    XmlOptions options) 
 public float floatValue() 
Deprecated! replaced - with #getFloatValue

 public GDate gDateValue() 
Deprecated! replaced - with #getGDateValue

 public GDuration gDurationValue() 
Deprecated! replaced - with #getGDurationValue

 public final XmlObject generatedSetterHelperImpl(XmlObject src,
    QName propName,
    int index,
    short kindSetterHelper) 
 public BigDecimal getBigDecimalValue() 
 public BigInteger getBigIntegerValue() 
 public boolean getBooleanValue() 
 public byte[] getByteArrayValue() 
 public byte getByteValue() 
 public Calendar getCalendarValue() 
 public Date getDateValue() 
 public Node getDomNode() 
 public double getDoubleValue() 
 public StringEnumAbstractBase getEnumValue() 
 public float getFloatValue() 
 public GDate getGDateValue() 
 public GDuration getGDurationValue() 
 public int getIntValue() 
 public List getListValue() 
 public long getLongValue() 
 public Object getObjectValue() 
 public QName getQNameValue() 
 public short getShortValue() 
 public String getStringValue() 
 public final XmlLocale getXmlLocale() 
 public SchemaField get_attribute_field(QName attrName) 
 public SchemaType get_attribute_type(QName attrName) 
 public int get_attributeflags(QName attrName) 
    Returns the flags for the given attribute.
 public String get_default_attribute_text(QName attrName) 
    Returns the default attribute text for the attribute with the given name, or null if no default.
 protected XmlAnySimpleType get_default_attribute_value(QName name) 
    Called by code generated code to get the default attribute value for a given attribute name, or null if none.
 public String get_default_element_text(QName eltName) 
    Returns the default element text, if it's consistent. If it's not consistent, returns null, and requires a visitor walk. Also returns null if there is no default at all (although that can also be discovered via get_elementflags without doing a walk).
 public final QNameSet get_element_ending_delimiters(QName eltname) 
    Inserting a new element is always unambiguous except in one situation: when adding an element after the last one with that name (or the first one if there are none). In that case, add the element at the first possible slot BEFORE any element whose qname is contained in the QNameSet given. (If the QNameSet is empty, that means add the new element at the very end.) If the returned QNameSet is null, treat it as if the QNameSet contained all QNames, i.e., add the new element at the very first position possible (adjacent to the last element of the same name, or at the very first slot if it is the first elt with that name).
 public SchemaType get_element_type(QName eltName,
    QName xsiType) 
 public int get_elementflags(QName eltName) 
    Returns the elementflags, if they're consistent. If they're not, returns -1, and requires a vistor walk.
 public SchemaType get_schema_type() 
 public final TypeStore get_store() 
    Used by the ComplexTypeImpl subclass to get direct access to the store.
 protected int get_wscanon_rule() 
    Returns the whitespace rule that will be applied before building a string to pass to get_text(). Overridden by subclasses that don't need their text for set_text canonicalized; perhaps they already implement scanners that can deal with whitespace, and they know they have no regex pattern restrictions.
 public final String get_wscanon_text() 
    Grabs the undelying litral representation, applying the implementation's wscanon rule. Null if not simple content.
 protected final boolean has_store() 
 public final int hashCode() 
 protected  void initComplexType(boolean complexType,
    boolean complexContent) 
    Called by restriction subclasses within their constructors to enable complex type support.
 public  void init_flags(SchemaProperty prop) 
 public SchemaType instanceType() 
 public int intValue() 
Deprecated! replaced - with #getIntValue

 public final  void invalidate_element_order() 
    Called by a TypeStore to indicate that the element's default value, nillability, fixedness, etc, may have changed by virtue of the element order changing (and xsi:nil and the text may have changed too); so the store should be consulted next time any setter or getter is called.
 public final  void invalidate_nilvalue() 
    Called by a TypeStore to indicate that the xsi:nil attribute on the containing element (and possibly the text) has been invalidated and both should be consulted next time the value is needed.
 public final  void invalidate_value() 
    Called by a TypeStore to indicate that the text has been invalidated and should be fetched next time the value is needed.
 public final boolean isDefault() 
    True if the value is currently defaulted.
 public final boolean isDefaultable() 
    True if the value is currently defaulted.
 public final boolean isFixed() 
    True if the value is fixed.
 public boolean isImmutable() 
    Is this instance an immutable value?
 public boolean isInstanceOf(SchemaType type) 
 public final boolean isNil() 
    True if the value is nilled.
 public final boolean isNillable() 
    True if the value is allowed to be nil.
 public boolean is_child_element_order_sensitive() 
    Returns false if child elements are insensitive to order; if it returns true, you're required to call invalidate_element_order on children to the right of any child order rearrangement.
 protected boolean is_defaultable_ws(String v) 
    Types should return false if they don't treat the given whitespace as a default value.
 protected final boolean is_orphaned() 
    Describes the orphaned status of this object.
 protected static Object java_value(XmlObject obj) 
 public List listValue() 
Deprecated! replaced - with #getListValue

 public long longValue() 
Deprecated! replaced - with #getLongValue

 public final Object monitor() 
 public XmlCursor newCursor() 
 public XmlCursor newCursorForce() 
 public Node newDomNode() 
 public Node newDomNode(XmlOptions options) 
 public InputStream newInputStream() 
 public InputStream newInputStream(XmlOptions options) 
 public Reader newReader() 
 public Reader newReader(XmlOptions options) 
 public XMLInputStream newXMLInputStream() 
Deprecated! XMLInputStream - was deprecated by XMLStreamReader from STaX - jsr173 API.

 public XMLInputStream newXMLInputStream(XmlOptions options) 
Deprecated! XMLInputStream - was deprecated by XMLStreamReader from STaX - jsr173 API.

 public XMLStreamReader newXMLStreamReader() 
 public XMLStreamReader newXMLStreamReader(XmlOptions options) 
 public TypeStoreVisitor new_visitor() 
    A typestore user can return a visitor that is used to compute default text and elementflags for an arbitrary element.
 public  void objectSet(Object obj) 
Deprecated! replaced - with #setObjectValue

 public Object objectValue() 
Deprecated! replaced - with #getObjectValue

 public QName qNameValue() 
Deprecated! replaced - with #getQNameValue

 public  void save(File file) throws IOException 
 public  void save(OutputStream os) throws IOException 
 public  void save(Writer w) throws IOException 
 public  void save(File file,
    XmlOptions options) throws IOException 
 public  void save(OutputStream os,
    XmlOptions options) throws IOException 
 public  void save(Writer w,
    XmlOptions options) throws IOException 
 public  void save(ContentHandler ch,
    LexicalHandler lh) throws SAXException 
 public  void save(ContentHandler ch,
    LexicalHandler lh,
    XmlOptions options) throws SAXException 
 abstract public SchemaType schemaType()
 public XmlObject selectAttribute(QName attributeName) 
    Selects the content of the attribute with the given name.
 public XmlObject selectAttribute(String attributeUri,
    String attributeLocalName) 
    Selects the content of the attribute with the given name.
 public XmlObject[] selectAttributes(QNameSet attributeNameSet) 
    Selects the contents of the attributes that are contained in the elementNameSet.
 public XmlObject[] selectChildren(QName elementName) 
    Selects the contents of the children elements with the given name.
 public XmlObject[] selectChildren(QNameSet elementNameSet) 
    Selects the contents of the children elements that are contained in the elementNameSet.
 public XmlObject[] selectChildren(String elementUri,
    String elementLocalName) 
    Selects the contents of the children elements with the given name.
 public XmlObject[] selectPath(String path) 
 public XmlObject[] selectPath(String path,
    XmlOptions options) 
 public  void set(String obj) 
Deprecated! replaced - with #setStringValue

 public  void set(boolean v) 
Deprecated! replaced - with #setBooleanValue

 public  void set(byte v) 
Deprecated! replaced - with #setByteValue

 public  void set(short v) 
Deprecated! replaced - with #setShortValue

 public  void set(int v) 
Deprecated! replaced - with #setIntValue

 public  void set(long v) 
Deprecated! replaced - with #setLongValue

 public  void set(BigInteger obj) 
Deprecated! replaced - with #setBigIntegerValue

 public  void set(BigDecimal obj) 
Deprecated! replaced - with #setBigDecimalValue

 public  void set(float v) 
Deprecated! replaced - with #setFloatValue

 public  void set(double v) 
Deprecated! replaced - with #setDoubleValue

 public  void set(byte[] obj) 
Deprecated! replaced - with #setByteArrayValue

 public  void set(StringEnumAbstractBase obj) 
Deprecated! replaced - with #setEnumValue

 public  void set(Calendar obj) 
Deprecated! replaced - with #setCalendarValue

 public  void set(Date obj) 
Deprecated! replaced - with #setDateValue

 public  void set(GDateSpecification obj) 
Deprecated! replaced - with #setGDateValue

 public  void set(GDurationSpecification obj) 
Deprecated! replaced - with #setGDurationValue

 public  void set(QName obj) 
Deprecated! replaced - with #setQNameValue

 public  void set(List obj) 
Deprecated! replaced - with #setListValue

 public final XmlObject set(XmlObject src) 
 public final  void setBigDecimalValue(BigDecimal obj) 
 public final  void setBigIntegerValue(BigInteger obj) 
 public final  void setBooleanValue(boolean v) 
 public final  void setByteArrayValue(byte[] obj) 
 public final  void setByteValue(byte v) 
 public final  void setCalendarValue(Calendar obj) 
 public final  void setDateValue(Date obj) 
 public final  void setDoubleValue(double v) 
 public final  void setEnumValue(StringEnumAbstractBase obj) 
 public final  void setFloatValue(float v) 
 public final  void setGDateValue(GDate obj) 
 public final  void setGDateValue(GDateSpecification obj) 
 public final  void setGDurationValue(GDuration obj) 
 public final  void setGDurationValue(GDurationSpecification obj) 
 public  void setImmutable() 
    Used to make a free-standing xml simple value instance immutable. This is a one-way street, and it is illegal to attempt to make a value that is embedded in an xml document immutable. Once a value is marked as immutable, it is illegal to call setters of any kind.
 public final  void setIntValue(int v) 
 public final  void setListValue(List obj) 
 public final  void setLongValue(long v) 
 public final  void setNil() 
    Nils the value.
 public  void setObjectValue(Object o) 
 public final  void setQNameValue(QName obj) 
 public final  void setShortValue(short v) 
 public final  void setStringValue(String obj) 
 public  void setValidateOnSet() 
 protected  void set_BigDecimal(BigDecimal v) 
 protected  void set_BigInteger(BigInteger v) 
 protected  void set_ByteArray(byte[] b) 
 protected  void set_Calendar(Calendar v) 
 protected  void set_ComplexXml(XmlObject v) 
 protected  void set_Date(Date v) 
 protected  void set_GDate(GDateSpecification v) 
 protected  void set_GDuration(GDurationSpecification v) 
 protected  void set_QName(QName v) 
 protected  void set_String(String v) 
    Setting a string preserves any noncanonical literal representation. This is done by storing the actual string in the underlying store after checking it against the primitive type for validity.
 protected  void set_b64(byte[] b) 
 protected  void set_boolean(boolean v) 
 protected  void set_byte(byte v) 
 protected  void set_char(char v) 
 protected  void set_double(double v) 
 protected  void set_enum(StringEnumAbstractBase e) 
 protected  void set_float(float v) 
 protected  void set_hex(byte[] b) 
 protected  void set_int(int v) 
 protected  void set_list(List list) 
 protected  void set_long(long v) 
 public final  void set_newValue(XmlObject obj) 
 abstract protected  void set_nil()
    This should clear the value, and set it to whatever is supposed to be returned when the value is nilled.
 protected  void set_notation(String v) 
 protected  void set_short(short v) 
 abstract protected  void set_text(String text)
    This should set the value of the type from text, or throw an XmlValueOutOfRangeException if it can't.
 protected  void set_xmlanysimple(XmlAnySimpleType v) 
 public short shortValue() 
Deprecated! replaced - with #getShortValue

 public String stringValue() 
Deprecated! replaced - with #getStringValue

 public XmlObject substitute(QName name,
    SchemaType type) 
 public final String toString() 
 protected  void update_from_complex_content() 
    Update the value based on complex content.
 public final boolean uses_invalidate_value() 
 public boolean validate() 
 public boolean validate(XmlOptions options) 
 public  void validate_now() 
    A store will call back on validate_now to force us to look at the text if we're in an invalid state. We're allowed to throw an exception if the text isn't valid for our type.
 protected  void validate_simpleval(String lexical,
    ValidationContext ctx) 
 public final boolean valueEquals(XmlObject xmlobj) 
 public int valueHashCode() 
 abstract protected int value_hash_code()
 public Object writeReplace() 
    This method can writeReplace either an unwrapped XmlObjectBase or an XBean proxy. A "true" argument means unwrapped. The serialization strategy for XmlObjects is this: (1) Only the root XmlObject for a document actually gets fully serialized; it is serialized as a SerializedRootObject, which simply saves itself as XML text. (2) Interior XmlObjects get serialized as a reference to the root XmlObject for their document, plus an integer which indicates the position of the XmlObject within the owner document. This pair is stored as a SerializedInteriorObject. Both objects can be maked as wrapped or unwrapped. If wrapped, then the proxy is returned when deserializing; if unwrapped, then the proxy is stripped when deserializing.
 public List xgetListValue() 
 public List xlistValue() 
Deprecated! replaced - with #xgetListValue

 public String xmlText() 
 public String xmlText(XmlOptions options)