Package com.yahoo.document

Class ReferenceDataType

java.lang.Object

com.yahoo.vespa.objects.Selectable

com.yahoo.vespa.objects.Identifiable

com.yahoo.document.DataType

com.yahoo.document.ReferenceDataType

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<DataType>

public class ReferenceDataType
extends DataType

A ReferenceDataType specifies a particular concrete document type that a ReferenceFieldValue instance binds to.

Author:

vekterli

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

Constructor	Description
ReferenceDataType(DocumentType targetType, int id)
ReferenceDataType(TemporaryStructuredDataType temporaryTargetType, int id)	Constructor used when building a multi document type model where the concrete instance of the target document type might not yet be known.

Method Summary

Modifier and Type	Method	Description
int	compareTo(DataType rhs)
ReferenceFieldValue	createFieldValue()	Creates a new, empty FieldValue of this type
static ReferenceDataType	createWithInferredId(DocumentType targetType)	Creates a new type where the numeric ID is based on the hash of targetType
static ReferenceDataType	createWithInferredId(TemporaryStructuredDataType targetType)	Creates a new type where the numeric ID is based on the hash of targetType
boolean	equals(java.lang.Object rhs)
StructuredDataType	getTargetType()
java.lang.Class<? extends ReferenceFieldValue>	getValueClass()
boolean	isValueCompatible(FieldValue value)
void	setTargetType(StructuredDataType targetType)	Overrides the stored temporary data type with a concrete StructuredDataType instance.

Methods inherited from class com.yahoo.document.DataType

buildFieldPath, clone, createByReflection, createFieldValue, getArray, getCode, getId, getMap, getName, getPrimitiveType, getTensor, getWeightedSet, getWeightedSet, hashCode, isAssignableFrom, isMultivalue, isRegistered, lastPredefinedDataTypeId, register, register, setId, setName, toString, visitMembers

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

create, createFromId, deserialize, deserializeOptional, deserializeWithId, equals, getClassId, 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 final int classId

Constructor Detail

ReferenceDataType

public ReferenceDataType(DocumentType targetType,
                         int id)

ReferenceDataType

public ReferenceDataType(TemporaryStructuredDataType temporaryTargetType,
                         int id)

Constructor used when building a multi document type model where the concrete instance of the target document type might not yet be known. The temporary data type should be replaced later using setTargetType().

Method Detail

createWithInferredId

public static ReferenceDataType createWithInferredId(DocumentType targetType)

Creates a new type where the numeric ID is based on the hash of targetType

createWithInferredId

public static ReferenceDataType createWithInferredId(TemporaryStructuredDataType targetType)

Creates a new type where the numeric ID is based on the hash of targetType

getTargetType

public StructuredDataType getTargetType()

setTargetType

public void setTargetType(StructuredDataType targetType)

Overrides the stored temporary data type with a concrete StructuredDataType instance. Should only be invoked from configuration or model code when resolving temporary types.

Throws:

java.lang.IllegalStateException - if the previously stored target type is already a concrete instance (not TemporaryStructuredDataType).

createFieldValue

public ReferenceFieldValue createFieldValue()

Description copied from class: DataType

Creates a new, empty FieldValue of this type

Specified by:

createFieldValue in class DataType

getValueClass

public java.lang.Class<? extends ReferenceFieldValue> getValueClass()

Specified by:

getValueClass in class DataType

isValueCompatible

public boolean isValueCompatible(FieldValue value)

Specified by:

isValueCompatible in class DataType

compareTo

public int compareTo(DataType rhs)

Specified by:

compareTo in interface java.lang.Comparable<DataType>

Overrides:

compareTo in class DataType

equals

public boolean equals(java.lang.Object rhs)

Overrides:

equals in class DataType