org.exist.xquery.value
Class StringValue

java.lang.Object
  org.exist.xquery.value.AtomicValue
      org.exist.xquery.value.StringValue

All Implemented Interfaces:

Comparable, Indexable, Item, Sequence

public class StringValue
extends AtomicValue

Field Summary

static StringValue

EMPTY_STRING

Fields inherited from class org.exist.xquery.value.AtomicValue

EMPTY_VALUE

Fields inherited from interface org.exist.xquery.value.Sequence

EMPTY_SEQUENCE

Constructor Summary

StringValue(String string)

StringValue(String string, int type)

StringValue(String string, int type, boolean expand)

Method Summary

static String	collapseWhitespace(CharSequence in) Collapses all sequences of adjacent whitespace chars in the input string into a single space.
int	compareTo(Collator collator, AtomicValue other)
boolean	compareTo(Collator collator, int operator, AtomicValue other)
int	compareTo(Object o)
boolean	contains(Collator collator, AtomicValue other) Compares this atomic value to another.
int	conversionPreference(Class javaClass) Returns a preference indicator, indicating the preference of a value to be converted into the given Java class.
AtomicValue	convertTo(int requiredType) Convert this item into an atomic value, whose type corresponds to the specified target type.
boolean	effectiveBooleanValue() Get the effective boolean value of this sequence.
boolean	endsWith(Collator collator, AtomicValue other) Compares this atomic value to another.
StringValue	expand()
static String	expand(CharSequence seq)
String	getStringValue() Return the string value of this item (see the definition of string value in XPath).
String	getStringValue(boolean bmpCheck)
int	getType() Returns the type of the Indexable as one of the constants defined in Type.
Item	itemAt(int pos) Returns the item located at the specified position within this sequence.
AtomicValue	max(Collator collator, AtomicValue other)
AtomicValue	min(Collator collator, AtomicValue other)
static String	normalizeWhitespace(CharSequence seq)
byte[]	serializeValue(int offset, boolean caseSensitive) Serialize for the persistant storage
boolean	startsWith(Collator collator, AtomicValue other) Compares this atomic value to another.
Object	toJavaObject(Class target) Convert the value into an instance of the specified Java class.
String	toString()
static String	trimWhitespace(String in)

Methods inherited from class org.exist.xquery.value.AtomicValue

add, addAll, atomize, clearContext, copyTo, dump, getCardinality, getCollectionIterator, getDocumentSet, getItemCount, getItemType, getState, hasChanged, hasMany, hasOne, isCacheable, isCached, isEmpty, isPersistentSet, iterate, nodeMoved, promote, removeDuplicates, serializeValue, setIsCached, setSelfAsContext, toMemNodeSet, toNodeSet, toSAX, toSequence, unorderedIterator

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY_STRING

public static final StringValue EMPTY_STRING

Constructor Detail

StringValue

public StringValue(String string,
                   int type)
            throws XPathException

Throws:

XPathException

StringValue

public StringValue(String string,
                   int type,
                   boolean expand)
            throws XPathException

Throws:

XPathException

StringValue

public StringValue(String string)

Method Detail

expand

public StringValue expand()
                   throws XPathException

Throws:

XPathException

getType

public int getType()

Description copied from interface: Indexable

Returns the type of the Indexable as one of the constants defined in Type.

Specified by:

getType in interface Indexable

Specified by:

getType in interface Item

Overrides:

getType in class AtomicValue

Returns:

Type of the Indexable

getStringValue

public String getStringValue()

Description copied from interface: Item

Return the string value of this item (see the definition of string value in XPath).

Specified by:

getStringValue in interface Item

Specified by:

getStringValue in interface Sequence

Specified by:

getStringValue in class AtomicValue

getStringValue

public String getStringValue(boolean bmpCheck)

itemAt

public Item itemAt(int pos)

Description copied from interface: Sequence

Returns the item located at the specified position within this sequence. Items are counted beginning at 0.

Specified by:

itemAt in interface Sequence

Overrides:

itemAt in class AtomicValue

convertTo

public AtomicValue convertTo(int requiredType)
                      throws XPathException

Description copied from interface: Item

Convert this item into an atomic value, whose type corresponds to the specified target type. requiredType should be one of the type constants defined in Type. An XPathException is thrown if the conversion is impossible.

Specified by:

convertTo in interface Item

Specified by:

convertTo in interface Sequence

Specified by:

convertTo in class AtomicValue

Parameters:

requiredType - one of the type constants defined in class Type

Throws:

XPathException

conversionPreference

public int conversionPreference(Class javaClass)

Description copied from interface: Sequence

Returns a preference indicator, indicating the preference of a value to be converted into the given Java class. Low numbers mean that the value can be easily converted into the given class.

Specified by:

conversionPreference in interface Item

Specified by:

conversionPreference in interface Sequence

Overrides:

conversionPreference in class AtomicValue

toJavaObject

public Object toJavaObject(Class target)
                    throws XPathException

Description copied from interface: Sequence

Convert the value into an instance of the specified Java class.

Specified by:

toJavaObject in interface Item

Specified by:

toJavaObject in interface Sequence

Overrides:

toJavaObject in class AtomicValue

Throws:

XPathException

compareTo

public boolean compareTo(Collator collator,
                         int operator,
                         AtomicValue other)
                  throws XPathException

Specified by:

compareTo in class AtomicValue

Throws:

XPathException

compareTo

public int compareTo(Collator collator,
                     AtomicValue other)
              throws XPathException

Specified by:

compareTo in class AtomicValue

Throws:

XPathException

startsWith

public boolean startsWith(Collator collator,
                          AtomicValue other)
                   throws XPathException

Description copied from class: AtomicValue

Compares this atomic value to another. Returns true if the current value is of type string and its value starts with the string value of the other value.

Overrides:

startsWith in class AtomicValue

Parameters:

collator - Collator used for string comparison.

Throws:

XPathException - if this is not a string.

endsWith

public boolean endsWith(Collator collator,
                        AtomicValue other)
                 throws XPathException

Description copied from class: AtomicValue

Compares this atomic value to another. Returns true if the current value is of type string and its value ends with the string value of the other value.

Overrides:

endsWith in class AtomicValue

Parameters:

collator - Collator used for string comparison.

Throws:

XPathException - if this is not a string.

contains

public boolean contains(Collator collator,
                        AtomicValue other)
                 throws XPathException

Description copied from class: AtomicValue

Compares this atomic value to another. Returns true if the current value is of type string and its value contains the string value of the other value.

Overrides:

contains in class AtomicValue

Parameters:

collator - Collator used for string comparison.

Throws:

XPathException - if this is not a string.

effectiveBooleanValue

public boolean effectiveBooleanValue()
                              throws XPathException

Description copied from interface: Sequence

Get the effective boolean value of this sequence. Will be false if the sequence is empty, true otherwise.

Specified by:

effectiveBooleanValue in interface Sequence

Specified by:

effectiveBooleanValue in class AtomicValue

Throws:

XPathException

toString

public String toString()

Overrides:

toString in class AtomicValue

normalizeWhitespace

public static final String normalizeWhitespace(CharSequence seq)

collapseWhitespace

public static String collapseWhitespace(CharSequence in)

Collapses all sequences of adjacent whitespace chars in the input string into a single space.

Parameters:

in -

trimWhitespace

public static final String trimWhitespace(String in)

expand

public static final String expand(CharSequence seq)
                           throws XPathException

Throws:

XPathException

max

public AtomicValue max(Collator collator,
                       AtomicValue other)
                throws XPathException

Specified by:

max in class AtomicValue

Throws:

XPathException

min

public AtomicValue min(Collator collator,
                       AtomicValue other)
                throws XPathException

Specified by:

min in class AtomicValue

Throws:

XPathException

compareTo

public int compareTo(Object o)

Specified by:

compareTo in interface Comparable

Overrides:

compareTo in class AtomicValue

serializeValue

public byte[] serializeValue(int offset,
                             boolean caseSensitive)

Serialize for the persistant storage

Parameters:

offset -