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:
Cloneable
,Comparable<FieldValue>
public class Struct extends StructuredFieldValue
- Author:
- HÃ¥kon Humberset
-
-
Field Summary
Fields Modifier and Type Field Description static int
classId
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
assign(Object o)
Assign this non-fieldvalue value to this field value.void
assignFrom(StructuredFieldValue sfv)
Clears this and assigns from the givenStructuredFieldValue
void
clear()
Struct
clone()
int
compareTo(FieldValue obj)
void
deserialize(Field field, FieldReader reader)
Read a field value from the specified readerprotected void
doSetFieldValue(Field field, FieldValue value)
boolean
equals(Object o)
int
getCompressionLevel()
Deprecated.Will go away on Vespa 8float
getCompressionThreshold()
Deprecated.Will go away on Vespa 8com.yahoo.compress.CompressionType
getCompressionType()
Deprecated.Will go away on Vespa 8StructDataType
getDataType()
Field
getField(String fieldName)
Returns the named field object, or null if that field does not exist.int
getFieldCount()
Set<Map.Entry<Field,FieldValue>>
getFields()
static <T> T
getFieldValue(FieldValue struct, DataType structType, Field field, Class<T> fieldType)
static <T> T
getFieldValue(FieldValue struct, DataType structType, String fieldName, Class<T> fieldType)
FieldValue
getFieldValue(Field field)
Returns the value of the given field.int
getVersion()
int
hashCode()
Iterator<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 writervoid
setVersion(int version)
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
-
-
-
-
Constructor Detail
-
Struct
public Struct(DataType type)
-
-
Method Detail
-
getDataType
public StructDataType getDataType()
- Overrides:
getDataType
in classStructuredFieldValue
-
setVersion
public void setVersion(int version)
-
getVersion
public int getVersion()
-
getCompressionType
@Deprecated public com.yahoo.compress.CompressionType getCompressionType()
Deprecated.Will go away on Vespa 8
-
getCompressionLevel
@Deprecated public int getCompressionLevel()
Deprecated.Will go away on Vespa 8
-
getCompressionThreshold
@Deprecated public float getCompressionThreshold()
Deprecated.Will go away on Vespa 8
-
clone
public Struct clone()
- Overrides:
clone
in classFieldValue
-
clear
public void clear()
- Specified by:
clear
in classStructuredFieldValue
-
iterator
public Iterator<Map.Entry<Field,FieldValue>> iterator()
- Specified by:
iterator
in classStructuredFieldValue
-
getFields
public Set<Map.Entry<Field,FieldValue>> getFields()
-
printXml
public void printXml(XmlStream xml)
- Specified by:
printXml
in classFieldValue
-
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 classStructuredFieldValue
- Parameters:
field
- The field whose value to return.- Returns:
- The value of the field, or null.
-
getField
public Field getField(String fieldName)
Description copied from class:StructuredFieldValue
Returns the named field object, or null if that field does not exist.- Specified by:
getField
in classStructuredFieldValue
- Parameters:
fieldName
- The name of the field to return.- Returns:
- The corresponding field, or null.
-
getFieldCount
public int getFieldCount()
- Specified by:
getFieldCount
in classStructuredFieldValue
-
doSetFieldValue
protected void doSetFieldValue(Field field, FieldValue value)
- Specified by:
doSetFieldValue
in classStructuredFieldValue
-
removeFieldValue
public FieldValue removeFieldValue(Field field)
Description copied from class:StructuredFieldValue
Removes and returns a field value.- Specified by:
removeFieldValue
in classStructuredFieldValue
- Parameters:
field
- The field whose value to remove.- Returns:
- The previous value of the field, or null.
-
assign
public void assign(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 classFieldValue
-
assignFrom
public void assignFrom(StructuredFieldValue sfv)
Clears this and assigns from the givenStructuredFieldValue
-
equals
public boolean equals(Object o)
- Overrides:
equals
in classCompositeFieldValue
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classCompositeFieldValue
-
toString
public String toString()
- Overrides:
toString
in classcom.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 classFieldValue
-
compareTo
public int compareTo(FieldValue obj)
- Specified by:
compareTo
in interfaceComparable<FieldValue>
- Overrides:
compareTo
in classFieldValue
-
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 classFieldValue
-
getFieldValue
public static <T> T getFieldValue(FieldValue struct, DataType structType, String fieldName, Class<T> fieldType)
-
getFieldValue
public static <T> T getFieldValue(FieldValue struct, DataType structType, Field field, Class<T> fieldType)
-
-