Package com.yahoo.document

Class StructuredDataType

java.lang.Object

com.yahoo.vespa.objects.Selectable

com.yahoo.vespa.objects.Identifiable

com.yahoo.document.DataType

com.yahoo.document.StructuredDataType

All Implemented Interfaces:

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

Direct Known Subclasses:

BaseStructDataType, DocumentType

public abstract class StructuredDataType
extends DataType

TODO: What is this and why

Author:

Håkon Humberset

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
StructuredDataType(int id, java.lang.String name)
StructuredDataType(java.lang.String name)

Method Summary

Modifier and Type	Method	Description
FieldPath	buildFieldPath(java.lang.String remainFieldName)	Creates a field path from the given field path string.
protected FieldValue	createByReflection(java.lang.Object arg)	Creates a field value by reflection
abstract StructuredFieldValue	createFieldValue()	Creates a new, empty FieldValue of this type
protected static int	createId(java.lang.String name)
boolean	equals(java.lang.Object o)
DataTypeName	getDataTypeName()	Returns the name of this as a DataTypeName
abstract Field	getField(int id)	Gets the field with the specified id.
abstract Field	getField(java.lang.String name)	Gets the field matching a given name.
abstract java.util.Collection<Field>	getFields()
int	hashCode()
protected void	register(DocumentTypeManager manager, java.util.List<DataType> seenTypes)

Methods inherited from class com.yahoo.document.DataType

clone, compareTo, createFieldValue, getArray, getCode, getId, getMap, getName, getPrimitiveType, getTensor, getValueClass, getWeightedSet, getWeightedSet, isAssignableFrom, isMultivalue, isRegistered, isValueCompatible, lastPredefinedDataTypeId, 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

StructuredDataType

public StructuredDataType(java.lang.String name)

StructuredDataType

public StructuredDataType(int id,
                          java.lang.String name)

Method Detail

createId

protected static int createId(java.lang.String name)

createFieldValue

public abstract StructuredFieldValue createFieldValue()

Description copied from class: DataType

Creates a new, empty FieldValue of this type

Specified by:

createFieldValue in class DataType

createByReflection

protected FieldValue createByReflection(java.lang.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

getDataTypeName

public DataTypeName getDataTypeName()

Returns the name of this as a DataTypeName

Returns:

Return the Documentname of this doumenttype.

getField

public abstract Field getField(java.lang.String name)

Gets the field matching a given name.

Parameters:

name - The name of a field.

Returns:

Returns the matching field, or null if not found.

getField

public abstract Field getField(int id)

Gets the field with the specified id.

Parameters:

id - the id of the field to return.

Returns:

the matching field, or null if not found.

getFields

public abstract java.util.Collection<Field> getFields()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class DataType

hashCode

public int hashCode()

Overrides:

hashCode in class DataType

register

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

Overrides:

register in class DataType

buildFieldPath

public FieldPath buildFieldPath(java.lang.String remainFieldName)

Description copied from class: DataType

Creates a field path from the given field path string.

Overrides:

buildFieldPath in class DataType

Parameters:

remainFieldName - a string containing the field path

Returns:

Returns a valid field path, parsed from the string