| org.apache.derby.iapi.types.XMLDataValue
All known Subclasses: org.apache.derby.iapi.types.XML,
| Method Summary | |
| public BooleanDataValue | XMLExists(SqlXmlUtil sqlxUtil)
The SQL/XML XMLExists operator.
Checks to see if evaluation of the query expression contained
within the received util object against this XML value returns
at least one item. | | public XMLDataValue | XMLParse(String text, boolean preserveWS, SqlXmlUtil sqlxUtil)
Method to parse an XML string and, if it's valid,
store the _serialized_ version locally and then return
this XMLDataValue.
Parameters:
text - The string value to check.
Parameters:
preserveWS - Whether or not to preserveignorable whitespace.
Parameters:
sqlxUtil - Contains SQL/XML objects and utilmethods that facilitate execution of XML-relatedoperations If 'text' constitutes a valid XML document,it has been stored in this XML value and this XMLvalue returned; otherwise, an exception is thrown. | | public XMLDataValue | XMLQuery(XMLDataValue result, SqlXmlUtil sqlxUtil)
Evaluate the XML query expression contained within the received
util object against this XML value and store the results into
the received XMLDataValue "result" param (assuming "result" is
non-null; else create a new XMLDataValue). | | public StringDataValue | XMLSerialize(StringDataValue result, int targetType, int targetWidth)
The SQL/XML XMLSerialize operator.
Serializes this XML value into a string with a user-specified
character type, and returns that string via the received
StringDataValue (if the received StringDataValue is non-null
and of the correct type; else, a new StringDataValue is
returned).
Parameters:
result - The result of a previous call to this method,null if not called yet.
Parameters:
targetType - The string type to which we want to serialize.
Parameters:
targetWidth - The width of the target type. | | public int | getXType()
Retrieve this XML value's qualified type. | | public boolean | hasTopLevelAttr()
Return whether or not this XML value represents a sequence
that has one or more top-level attribute nodes. | | public void | markAsHavingTopLevelAttr()
Take note of the fact this XML value represents an XML
sequence that has one or more top-level attribute nodes. | | public void | setXType(int xtype)
Set this XML value's qualified type. |
| XMLExists | | public BooleanDataValue XMLExists(SqlXmlUtil sqlxUtil) throws StandardException(Code) | | The SQL/XML XMLExists operator.
Checks to see if evaluation of the query expression contained
within the received util object against this XML value returns
at least one item. NOTE: For now, the query expression must be
XPath only (XQuery not supported) because that's what Xalan
supports.
Parameters:
sqlxUtil - Contains SQL/XML objects and utilmethods that facilitate execution of XML-relatedoperations True if evaluation of the query expression storedin sqlxUtil returns at least one node for this XML value;unknown if the xml value is NULL; false otherwise.
exception:
StandardException - Thrown on error |
| XMLParse | | public XMLDataValue XMLParse(String text, boolean preserveWS, SqlXmlUtil sqlxUtil) throws StandardException(Code) | | Method to parse an XML string and, if it's valid,
store the _serialized_ version locally and then return
this XMLDataValue.
Parameters:
text - The string value to check.
Parameters:
preserveWS - Whether or not to preserveignorable whitespace.
Parameters:
sqlxUtil - Contains SQL/XML objects and utilmethods that facilitate execution of XML-relatedoperations If 'text' constitutes a valid XML document,it has been stored in this XML value and this XMLvalue returned; otherwise, an exception is thrown.
exception:
StandardException - Thrown on error. |
| XMLQuery | | public XMLDataValue XMLQuery(XMLDataValue result, SqlXmlUtil sqlxUtil) throws StandardException(Code) | | Evaluate the XML query expression contained within the received
util object against this XML value and store the results into
the received XMLDataValue "result" param (assuming "result" is
non-null; else create a new XMLDataValue).
Parameters:
result - The result of a previous call to this method; nullif not called yet.
Parameters:
sqlxUtil - Contains SQL/XML objects and util methods thatfacilitate execution of XML-related operations An XMLDataValue whose content corresponds to the serializedversion of the results from evaluation of the query expression.Note: this XMLDataValue may not be storable into Derby XMLcolumns.
exception:
Exception - thrown on error (and turned into aStandardException by the caller). |
| XMLSerialize | | public StringDataValue XMLSerialize(StringDataValue result, int targetType, int targetWidth) throws StandardException(Code) | | The SQL/XML XMLSerialize operator.
Serializes this XML value into a string with a user-specified
character type, and returns that string via the received
StringDataValue (if the received StringDataValue is non-null
and of the correct type; else, a new StringDataValue is
returned).
Parameters:
result - The result of a previous call to this method,null if not called yet.
Parameters:
targetType - The string type to which we want to serialize.
Parameters:
targetWidth - The width of the target type. A serialized (to string) version of this XML object,in the form of a StringDataValue object.
exception:
StandardException - Thrown on error |
| getXType | | public int getXType()(Code) | | Retrieve this XML value's qualified type.
|
| hasTopLevelAttr | | public boolean hasTopLevelAttr()(Code) | | Return whether or not this XML value represents a sequence
that has one or more top-level attribute nodes.
|
| markAsHavingTopLevelAttr | | public void markAsHavingTopLevelAttr()(Code) | | Take note of the fact this XML value represents an XML
sequence that has one or more top-level attribute nodes.
|
| setXType | | public void setXType(int xtype)(Code) | | Set this XML value's qualified type.
|
|
|