Package com.yahoo.document

Class BaseStructDataType

java.lang.Object

com.yahoo.vespa.objects.Selectable

com.yahoo.vespa.objects.Identifiable

com.yahoo.document.DataType

com.yahoo.document.StructuredDataType

com.yahoo.document.BaseStructDataType

All Implemented Interfaces:

Serializable, Cloneable, Comparable<DataType>

Direct Known Subclasses:

StructDataType

public abstract class BaseStructDataType
extends StructuredDataType

Date: Apr 15, 2008

Author:

humbe

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<Integer,Field>	fieldIds
protected Map<String,Field>	fields

Fields inherited from class com.yahoo.document.StructuredDataType

classId

Fields inherited from class com.yahoo.document.DataType

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

Method Summary

Modifier and Type	Method	Description
void	addField(Field field)
protected void	assign(BaseStructDataType type)
void	clearFields()
BaseStructDataType	clone()
CompressionConfig	getCompressionConfig()	Deprecated. Will go away on Vespa 8
com.yahoo.compress.Compressor	getCompressor()	Deprecated. Will go away on Vespa 8
Field	getField(int id)	Gets the field with the specified id.
Field	getField(String fieldName)	Gets the field matching a given name.
int	getFieldCount()
Collection<Field>	getFields()
boolean	hasField(Field field)
boolean	hasField(String name)
Field	removeField(String fieldName)
void	setCompressionConfig(CompressionConfig config)	Deprecated. Ignored and will go away on Vespa 8

Methods inherited from class com.yahoo.document.StructuredDataType

buildFieldPath, createByReflection, createFieldValue, createId, equals, getDataTypeName, hashCode, register

Methods inherited from class com.yahoo.document.DataType

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, 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 Details

fieldIds

protected Map<Integer,Field> fieldIds

fields

protected Map<String,Field> fields

Method Details

assign

protected void assign(BaseStructDataType type)

clone

public BaseStructDataType clone()

Overrides:

clone in class DataType

addField

public void addField(Field field)

removeField

public Field removeField(String fieldName)

clearFields

public void clearFields()

getField

public Field getField(String fieldName)

Description copied from class: StructuredDataType

Gets the field matching a given name.

Specified by:

getField in class StructuredDataType

Parameters:

fieldName - The name of a field.

Returns:

Returns the matching field, or null if not found.

getField

public Field getField(int id)

Description copied from class: StructuredDataType

Gets the field with the specified id.

Specified by:

getField in class StructuredDataType

Parameters:

id - the id of the field to return.

Returns:

the matching field, or null if not found.

hasField

public boolean hasField(Field field)

hasField

public boolean hasField(String name)

getFields

public Collection<Field> getFields()

Specified by:

getFields in class StructuredDataType

getFieldCount

public int getFieldCount()

getCompressor

@Deprecated
public com.yahoo.compress.Compressor getCompressor()

Deprecated.

Will go away on Vespa 8

Returns the compressor to use to compress data of this type

getCompressionConfig

@Deprecated
public CompressionConfig getCompressionConfig()

Deprecated.

Will go away on Vespa 8

Returns a view of the configuration of the compressor used to compress this type

setCompressionConfig

@Deprecated
public void setCompressionConfig(CompressionConfig config)

Deprecated.

Ignored and will go away on Vespa 8

Set the config to the compressor used to compress data of this type