com.yahoo.document.datatypes

Class FieldValue

java.lang.Object

com.yahoo.vespa.objects.Selectable

com.yahoo.vespa.objects.Identifiable

com.yahoo.document.datatypes.FieldValue

All Implemented Interfaces:

Cloneable, Comparable<FieldValue>

Direct Known Subclasses:

AnnotationReference, CompositeFieldValue, NumericFieldValue, PredicateFieldValue, Raw, ReferenceFieldValue, StringFieldValue, TensorFieldValue

public abstract class FieldValue
extends com.yahoo.vespa.objects.Identifiable
implements Comparable<FieldValue>

Author:

Einar M R Rosenvinge

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	FieldValue.RecursiveIteratorHandler

Field Summary

Fields

Modifier and Type	Field and Description
static int	classId

Constructor Summary

Constructors

Constructor and Description
FieldValue()

Method Summary

Modifier and Type	Method and Description
abstract void	assign(Object o) Assign this non-fieldvalue value to this field value.
(package private) boolean	checkAssign(Object o)
abstract void	clear()
FieldValue	clone()
int	compareTo(FieldValue fieldValue)
static FieldValue	create(FieldReader reader, DataType type)
abstract void	deserialize(Field field, FieldReader reader) Read a field value from the specified reader
void	deserialize(FieldReader reader) Read data from the given buffer to create this field value.
abstract DataType	getDataType()
FieldValue	getRecursiveValue(FieldPath path)
FieldValue	getRecursiveValue(String path) Using the given field path, digs through the document and returns the matching field value.
Object	getWrappedValue() Used to retrieve wrapped type for simple types, such that you can use get methods to retrieve ints and floats directly instead of Int/Float field values.
(package private) FieldPathIteratorHandler.ModificationStatus	iterateNested(FieldPath fieldPath, int pos, FieldPathIteratorHandler handler) Iterates through the document using the given fieldpath, calling callbacks in the given iterator handler.
void	onDeserialize(com.yahoo.vespa.objects.Deserializer data)
void	onSerialize(com.yahoo.vespa.objects.Serializer target)
abstract void	printXml(XmlStream xml)
abstract void	serialize(Field field, FieldWriter writer) Write out field value to the specified writer
void	serialize(com.yahoo.io.GrowableByteBuffer buf)
String	toXml() Get XML representation of a single field and all its children, if any.

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

create, createFromId, deserialize, deserializeOptional, deserializeWithId, equals, equals, getClassId, getUtf8, hashCode, onGetClassId, putUtf8, registerClass, serialize, serializeOptional, serializeWithId, toString, 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

Constructor Detail

FieldValue

public FieldValue()

Method Detail

getDataType

public abstract DataType getDataType()

create

public static FieldValue create(FieldReader reader,
                                DataType type)

toXml

public String toXml()

Get XML representation of a single field and all its children, if any.

Returns:

XML representation of field in a <value> element

deserialize

public final void deserialize(FieldReader reader)

Read data from the given buffer to create this field value. As some field values have their type self contained, we need the type manager object to be able to retrieve it.

serialize

public final void serialize(com.yahoo.io.GrowableByteBuffer buf)

printXml

public abstract void printXml(XmlStream xml)

clear

public abstract void clear()

clone

public FieldValue clone()

Overrides:

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

checkAssign

boolean checkAssign(Object o)

assign

public abstract void assign(Object o)

Assign this non-fieldvalue value to this field value. This is used to be able to assign ints to Integer field values and List to Array field values and such.

Override to accept the specific types that should be legal.

Throws:

IllegalArgumentException - If the object given is of wrong type for this field value.

getWrappedValue

public Object getWrappedValue()

Used to retrieve wrapped type for simple types, such that you can use get methods to retrieve ints and floats directly instead of Int/Float field values. Complex types that can't be specified by simple java types just return themself.

getRecursiveValue

public FieldValue getRecursiveValue(String path)

Using the given field path, digs through the document and returns the matching field value. If the field path resolves to multiple values, returns an ArrayFieldValue containing the values.

getRecursiveValue

public FieldValue getRecursiveValue(FieldPath path)

onSerialize

public void onSerialize(com.yahoo.vespa.objects.Serializer target)

Overrides:

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

onDeserialize

public void onDeserialize(com.yahoo.vespa.objects.Deserializer data)

Overrides:

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

iterateNested

FieldPathIteratorHandler.ModificationStatus iterateNested(FieldPath fieldPath,
                                                          int pos,
                                                          FieldPathIteratorHandler handler)

Iterates through the document using the given fieldpath, calling callbacks in the given iterator handler.

serialize

public abstract void serialize(Field field,
                               FieldWriter writer)

Write out field value to the specified writer

deserialize

public abstract void deserialize(Field field,
                                 FieldReader reader)

Read a field value from the specified reader

compareTo

public int compareTo(FieldValue fieldValue)

Specified by:

compareTo in interface Comparable<FieldValue>