Package com.yahoo.document.datatypes

Class Struct

java.lang.Object

com.yahoo.vespa.objects.Selectable

com.yahoo.vespa.objects.Identifiable

com.yahoo.document.datatypes.FieldValue

com.yahoo.document.datatypes.CompositeFieldValue

com.yahoo.document.datatypes.StructuredFieldValue

com.yahoo.document.datatypes.Struct

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<FieldValue>

public class Struct
extends StructuredFieldValue

Author:

Håkon Humberset

Field Summary

Fields

Modifier and Type	Field	Description
static int	classId

Constructor Summary

Constructors

Constructor	Description
Struct(DataType type)

Method Summary

Modifier and Type	Method	Description
void	assign(java.lang.Object o)	Assign this non-fieldvalue value to this field value.
void	assignFrom(StructuredFieldValue sfv)	Clears this and assigns from the given StructuredFieldValue
void	clear()
Struct	clone()
int	compareTo(FieldValue obj)
void	deserialize(Field field, FieldReader reader)	Read a field value from the specified reader
protected void	doSetFieldValue(Field field, FieldValue value)
boolean	equals(java.lang.Object o)
int	getCompressionLevel()
float	getCompressionThreshold()
com.yahoo.compress.CompressionType	getCompressionType()
StructDataType	getDataType()
Field	getField(java.lang.String fieldName)	Returns the named field object, or null if that field does not exist.
int	getFieldCount()
java.util.Set<java.util.Map.Entry<Field,FieldValue>>	getFields()
static <T> T	getFieldValue(FieldValue struct, DataType structType, Field field, java.lang.Class<T> fieldType)
static <T> T	getFieldValue(FieldValue struct, DataType structType, java.lang.String fieldName, java.lang.Class<T> fieldType)
FieldValue	getFieldValue(Field field)	Returns the value of the given field.
int	getVersion()
int	hashCode()
java.util.Iterator<java.util.Map.Entry<Field,FieldValue>>	iterator()
void	printXml(XmlStream xml)
FieldValue	removeFieldValue(Field field)	Removes and returns a field value.
void	serialize(Field field, FieldWriter writer)	Write out field value to the specified writer
void	setVersion(int version)
java.lang.String	toString()

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

getFieldValue, isGenerated, iterateNested, removeFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue

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

setDataType

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

create, deserialize, getRecursiveValue, getRecursiveValue, getWrappedValue, 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

Constructor Detail

Struct

public Struct(DataType type)

Method Detail

getDataType

public StructDataType getDataType()

Overrides:

getDataType in class StructuredFieldValue

setVersion

public void setVersion(int version)

getVersion

public int getVersion()

getCompressionType

public com.yahoo.compress.CompressionType getCompressionType()

getCompressionLevel

public int getCompressionLevel()

getCompressionThreshold

public float getCompressionThreshold()

clone

public Struct clone()

Overrides:

clone in class FieldValue

clear

public void clear()

Specified by:

clear in class StructuredFieldValue

iterator

public java.util.Iterator<java.util.Map.Entry<Field,FieldValue>> iterator()

Specified by:

iterator in class StructuredFieldValue

getFields

public java.util.Set<java.util.Map.Entry<Field,FieldValue>> getFields()

printXml

public void printXml(XmlStream xml)

Specified by:

printXml in class FieldValue

getFieldValue

public FieldValue getFieldValue(Field field)

Description copied from class: StructuredFieldValue

Returns the value of the given field. If the field does not exist, this method returns null.

Specified by:

getFieldValue in class StructuredFieldValue

Parameters:

field - The field whose value to return.

Returns:

The value of the field, or null.

getField

public Field getField(java.lang.String fieldName)

Description copied from class: StructuredFieldValue

Returns the named field object, or null if that field does not exist.

Specified by:

getField in class StructuredFieldValue

Parameters:

fieldName - The name of the field to return.

Returns:

The corresponding field, or null.

getFieldCount

public int getFieldCount()

Specified by:

getFieldCount in class StructuredFieldValue

doSetFieldValue

protected void doSetFieldValue(Field field,
                               FieldValue value)

Specified by:

doSetFieldValue in class StructuredFieldValue

removeFieldValue

public FieldValue removeFieldValue(Field field)

Description copied from class: StructuredFieldValue

Removes and returns a field value.

Specified by:

removeFieldValue in class StructuredFieldValue

Parameters:

field - The field whose value to remove.

Returns:

The previous value of the field, or null.

assign

public void assign(java.lang.Object o)

Description copied from class: FieldValue

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.

Specified by:

assign in class FieldValue

assignFrom

public void assignFrom(StructuredFieldValue sfv)

Clears this and assigns from the given StructuredFieldValue

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class CompositeFieldValue

hashCode

public int hashCode()

Overrides:

hashCode in class CompositeFieldValue

toString

public java.lang.String toString()

Overrides:

toString 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

compareTo

public int compareTo(FieldValue obj)

Specified by:

compareTo in interface java.lang.Comparable<FieldValue>

Overrides:

compareTo 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

getFieldValue

public static <T> T getFieldValue(FieldValue struct,
                                  DataType structType,
                                  java.lang.String fieldName,
                                  java.lang.Class<T> fieldType)

getFieldValue

public static <T> T getFieldValue(FieldValue struct,
                                  DataType structType,
                                  Field field,
                                  java.lang.Class<T> fieldType)