Package com.yahoo.document

Class CollectionDataType

java.lang.Object

com.yahoo.vespa.objects.Selectable

com.yahoo.vespa.objects.Identifiable

com.yahoo.document.DataType

com.yahoo.document.CollectionDataType

All Implemented Interfaces:

Serializable, Cloneable, Comparable<DataType>

Direct Known Subclasses:

ArrayDataType, WeightedSetDataType

public abstract class CollectionDataType
extends DataType

Author:

Einar M R Rosenvinge

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static int	classId

Fields inherited from class com.yahoo.document.DataType

BOOL, BYTE, DOCUMENT, DOUBLE, FLOAT, FLOAT16, INT, LONG, NONE, PREDICATE, RAW, STRING, TAG, tensorDataTypeCode, URI

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CollectionDataType(String name, int code, DataType nestedType)

Method Summary

Modifier and Type	Method	Description
CollectionDataType	clone()
protected FieldValue	createByReflection(Object arg)	Creates a field value by reflection
abstract CollectionFieldValue<?>	createFieldValue()	Creates a new, empty FieldValue of this type
DataType	getNestedType()
PrimitiveDataType	getPrimitiveType()	Returns the primitive datatype associated with this datatype, i.e.
boolean	isMultivalue()	Returns whether this is a multivalue type, i.e either a CollectionDataType or a MapDataType
boolean	isValueCompatible(FieldValue value)
protected void	register(DocumentTypeManager manager, List<DataType> seenTypes)
void	setNestedType(DataType nestedType)	Deprecated, for removal: This API element is subject to removal in a future version. // TODO Vespa 8 remove
void	visitMembers(com.yahoo.vespa.objects.ObjectVisitor visitor)

Methods inherited from class com.yahoo.document.DataType

buildFieldPath, compareTo, createFieldValue, equals, getArray, getCode, getId, getMap, getName, getTensor, getValueClass, getWeightedSet, getWeightedSet, hashCode, isAssignableFrom, isRegistered, lastPredefinedDataTypeId, register, setId, setName, toString

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

create, createFromId, deserialize, deserializeOptional, deserializeWithId, equals, getClassId, getRawUtf8Bytes, getUtf8, onDeserialize, onGetClassId, onSerialize, putUtf8, registerClass, serialize, serializeOptional, serializeWithId

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 int classId

Constructor Detail

CollectionDataType

protected CollectionDataType(String name,
                             int code,
                             DataType nestedType)

Method Detail

createFieldValue

public abstract CollectionFieldValue<?> createFieldValue()

Description copied from class: DataType

Creates a new, empty FieldValue of this type

Specified by:

createFieldValue in class DataType

clone

public CollectionDataType clone()

Overrides:

clone in class DataType

getNestedType

public DataType getNestedType()

createByReflection

protected FieldValue createByReflection(Object arg)

Description copied from class: DataType

Creates a field value by reflection

Overrides:

createByReflection in class DataType

Parameters:

arg - the value of the newly created field value

Returns:

a fully constructed value

setNestedType

@Deprecated(forRemoval=true,
            since="7")
public void setNestedType(DataType nestedType)

Deprecated, for removal: This API element is subject to removal in a future version.

// TODO Vespa 8 remove

WARNING! Do not use! Only to be used by config system! Sets the nested type of this CollectionDataType.

getPrimitiveType

public PrimitiveDataType getPrimitiveType()

Description copied from class: DataType

Returns the primitive datatype associated with this datatype, i.e. the type itself if this is a PrimitiveDataType, the nested type if this is a CollectionDataType or null for all other cases

Overrides:

getPrimitiveType in class DataType

Returns:

primitive data type, or null

isValueCompatible

public boolean isValueCompatible(FieldValue value)

Specified by:

isValueCompatible in class DataType

register

protected void register(DocumentTypeManager manager,
                        List<DataType> seenTypes)

Overrides:

register in class DataType

visitMembers

public void visitMembers(com.yahoo.vespa.objects.ObjectVisitor visitor)

Overrides:

visitMembers in class DataType

isMultivalue

public boolean isMultivalue()

Description copied from class: DataType

Returns whether this is a multivalue type, i.e either a CollectionDataType or a MapDataType

Overrides:

isMultivalue in class DataType