com.yahoo.document.datatypes

Class StringFieldValue

java.lang.Object

com.yahoo.vespa.objects.Selectable

com.yahoo.vespa.objects.Identifiable

com.yahoo.document.datatypes.FieldValue

com.yahoo.document.datatypes.StringFieldValue

All Implemented Interfaces:

Cloneable, Comparable<FieldValue>

Direct Known Subclasses:

UriFieldValue

public class StringFieldValue
extends FieldValue

A StringFieldValue is a wrapper class that holds a String in Documents and other FieldValues. String fields can only contain text characters, as defined by Text.isTextCharacter(int)

Author:

Einar M R Rosenvinge

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	StringFieldValue.Factory

Nested classes/interfaces inherited from class com.yahoo.document.datatypes.FieldValue

FieldValue.RecursiveIteratorHandler

Field Summary

Fields

Modifier and Type	Field and Description
static int	classId
private Map<String,SpanTree>	spanTrees
private String	value

Constructor Summary

Constructors

Constructor and Description
StringFieldValue() Creates a new StringFieldValue holding an empty String.
StringFieldValue(String value) Creates a new StringFieldValue with the given value.

Method Summary

Modifier and Type	Method and Description
void	assign(Object o) Sets a new value for this StringFieldValue. NOTE that doing so will clear all span trees from this value, since they most certainly will not make sense for a new string value.
void	clear() Sets the wrapped String to be an empty String, and clears all span trees.
StringFieldValue	clone() Clones this StringFieldValue and its span trees.
int	compareTo(FieldValue fieldValue)
void	deserialize(Field field, FieldReader reader) Read a field value from the specified reader
boolean	equals(Object o)
DataType	getDataType() Returns DataType.STRING.
static PrimitiveDataType.Factory	getFactory()
SpanTree	getSpanTree(String name) Returns the span tree associated with the given name, or null if this does not exist.
Map<String,SpanTree>	getSpanTreeMap()
Collection<SpanTree>	getSpanTrees() Returns an unmodifiable Collection of the span trees with annotations over this String, if any.
String	getString() Returns the String value wrapped by this StringFieldValue.
Object	getWrappedValue() Returns the String value wrapped by this StringFieldValue.
int	hashCode()
void	printXml(XmlStream xml) Prints XML in Vespa Document XML format for this StringFieldValue.
SpanTree	removeSpanTree(String name) Removes the span tree associated with the given name.
void	serialize(Field field, FieldWriter writer) Write out field value to the specified writer
SpanTree	setSpanTree(SpanTree spanTree) Sets the span tree with annotations over this String.
void	setUnChecked(String s) Only for use by deserializer to avoid the cost of verifying input.
private void	setValue(String value)
String	toString() Returns the String value wrapped by this StringFieldValue.
private static void	validateTextString(String value)

Methods inherited from class com.yahoo.document.datatypes.FieldValue

checkAssign, create, deserialize, getRecursiveValue, getRecursiveValue, iterateNested, onDeserialize, onSerialize, serialize, toXml

Methods inherited from class com.yahoo.vespa.objects.Identifiable

create, createFromId, deserialize, deserializeOptional, deserializeWithId, equals, getClassId, getUtf8, onGetClassId, putUtf8, registerClass, serialize, serializeOptional, serializeWithId, visitMembers

Methods inherited from class com.yahoo.vespa.objects.Selectable

select, select, selectMembers

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

classId

public static final int classId

value

private String value

spanTrees

private Map<String,SpanTree> spanTrees

Constructor Detail

StringFieldValue

public StringFieldValue()

Creates a new StringFieldValue holding an empty String.

StringFieldValue

public StringFieldValue(String value)

Creates a new StringFieldValue with the given value.

Parameters:

value - the value to wrap.

Throws:

IllegalArgumentException - if the string contains non-text characters as defined by Text.isTextCharacter(int)

Method Detail

getFactory

public static PrimitiveDataType.Factory getFactory()

validateTextString

private static void validateTextString(String value)

setValue

private void setValue(String value)

getDataType

public DataType getDataType()

Returns DataType.STRING.

Specified by:

getDataType in class FieldValue

Returns:

DataType.STRING, always

See Also:

DataType

clone

public StringFieldValue clone()

Clones this StringFieldValue and its span trees.

Overrides:

clone in class FieldValue

Returns:

a new deep-copied StringFieldValue

clear

public void clear()

Sets the wrapped String to be an empty String, and clears all span trees.

Specified by:

clear in class FieldValue

assign

public void assign(Object o)

Sets a new value for this StringFieldValue. NOTE that doing so will clear all span trees from this value, since they most certainly will not make sense for a new string value.

Specified by:

assign in class FieldValue

Parameters:

o - the new String to assign to this. An argument of null is equal to calling clear().

Throws:

IllegalArgumentException - if the given argument is a string containing non-text characters as defined by Text.isTextCharacter(int)

getSpanTrees

public Collection<SpanTree> getSpanTrees()

Returns an unmodifiable Collection of the span trees with annotations over this String, if any.

Returns:

an unmodifiable Collection of the span trees with annotations over this String, or an empty Collection

getSpanTreeMap

public final Map<String,SpanTree> getSpanTreeMap()

Returns:

The map of spantrees. Might be null.

getSpanTree

public SpanTree getSpanTree(String name)

Returns the span tree associated with the given name, or null if this does not exist.

Parameters:

name - the name of the span tree to return

Returns:

the span tree associated with the given name, or null if this does not exist.

setSpanTree

public SpanTree setSpanTree(SpanTree spanTree)

Sets the span tree with annotations over this String.

Parameters:

spanTree - the span tree with annotations over this String

Returns:

the input spanTree for chaining

Throws:

IllegalArgumentException - if a span tree with the given name already exists.

removeSpanTree

public SpanTree removeSpanTree(String name)

Removes the span tree associated with the given name.

Parameters:

name - the name of the span tree to remove

Returns:

the span tree previously associated with the given name, or null if it did not exist.

getString

public String getString()

Returns the String value wrapped by this StringFieldValue.

Returns:

the String value wrapped by this StringFieldValue.

getWrappedValue

public Object getWrappedValue()

Returns the String value wrapped by this StringFieldValue.

Overrides:

getWrappedValue in class FieldValue

Returns:

the String value wrapped by this StringFieldValue.

printXml

public void printXml(XmlStream xml)

Prints XML in Vespa Document XML format for this StringFieldValue.

Specified by:

printXml in class FieldValue

Parameters:

xml - the stream to print to.

toString

public String toString()

Returns the String value wrapped by this StringFieldValue.

Overrides:

toString in class com.yahoo.vespa.objects.Identifiable

Returns:

the String value wrapped by this StringFieldValue.

equals

public boolean equals(Object o)

Overrides:

equals in class com.yahoo.vespa.objects.Identifiable

hashCode

public int hashCode()

Overrides:

hashCode in class com.yahoo.vespa.objects.Identifiable

serialize

public void serialize(Field field,
                      FieldWriter writer)

Description copied from class: FieldValue

Write out field value to the specified writer

Specified by:

serialize in class FieldValue

deserialize

public void deserialize(Field field,
                        FieldReader reader)

Description copied from class: FieldValue

Read a field value from the specified reader

Specified by:

deserialize in class FieldValue

compareTo

public int compareTo(FieldValue fieldValue)

Specified by:

compareTo in interface Comparable<FieldValue>

Overrides:

compareTo in class FieldValue

setUnChecked

public void setUnChecked(String s)

Only for use by deserializer to avoid the cost of verifying input.