Package com.yahoo.document

Class MapDataType

java.lang.Object

com.yahoo.vespa.objects.Selectable

com.yahoo.vespa.objects.Identifiable

com.yahoo.document.DataType

com.yahoo.document.MapDataType

All Implemented Interfaces:

Serializable, Cloneable, Comparable<DataType>

public class MapDataType
extends DataType

Represents a map type.

Author:

vegardh

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.yahoo.document.DataType

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

Constructor Summary

Constructors

Constructor	Description
MapDataType(DataType keyType, DataType valueType)
MapDataType(DataType keyType, DataType valueType, int id)

Method Summary

Modifier and Type	Method	Description
FieldPath	buildFieldPath(String remainFieldName)	Creates a field path from the given field path string.
static FieldPath	buildFieldPath(String remainFieldName, DataType keyType, DataType valueType)
MapDataType	clone()
protected FieldValue	createByReflection(Object arg)	Creates a field value by reflection
MapFieldValue	createFieldValue()	Creates a new, empty FieldValue of this type
DataType	getKeyType()
Class	getValueClass()
DataType	getValueType()
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	setKeyType(DataType keyType)	Deprecated, for removal: This API element is subject to removal in a future version. // TODO Vespa 8 remove
void	setValueType(DataType valueType)	Deprecated, for removal: This API element is subject to removal in a future version. // TODO Vespa 8 remove

Methods inherited from class com.yahoo.document.DataType

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

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

Constructor Details

MapDataType

public MapDataType(DataType keyType,
 DataType valueType,
 int id)

MapDataType

public MapDataType(DataType keyType,
 DataType valueType)

Method Details

clone

public MapDataType clone()

Overrides:

clone in class DataType

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

isValueCompatible

public boolean isValueCompatible(FieldValue value)

Specified by:

isValueCompatible in class DataType

getKeyType

public DataType getKeyType()

getValueType

public DataType getValueType()

setKeyType

@Deprecated(forRemoval=true,
            since="7")
public void setKeyType(DataType keyType)

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 key type of this MapDataType.

setValueType

@Deprecated(forRemoval=true,
            since="7")
public void setValueType(DataType valueType)

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 value type of this MapDataType.

createFieldValue

public MapFieldValue createFieldValue()

Description copied from class: DataType

Creates a new, empty FieldValue of this type

Specified by:

createFieldValue in class DataType

getValueClass

public Class getValueClass()

Specified by:

getValueClass in class DataType

register

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

Overrides:

register in class DataType

buildFieldPath

public static FieldPath buildFieldPath(String remainFieldName,
 DataType keyType,
 DataType valueType)

buildFieldPath

public FieldPath buildFieldPath(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

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