com.yahoo.document

Class Field

java.lang.Object

com.yahoo.vespa.objects.FieldBase

com.yahoo.document.Field

All Implemented Interfaces:

FieldSet, Serializable, Comparable

Direct Known Subclasses:

ExtendedField

public class Field
extends com.yahoo.vespa.objects.FieldBase
implements FieldSet, Comparable, Serializable

A name and type. Fields are contained in document types to describe their fields, but is also used to represent name/type pairs which are not part of document types.

Author:

Thomas Gundersen, bratseth

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected DataType	dataType
protected int	fieldId
private int	fieldIdV6
private boolean	forcedId
private boolean	isHeader

Constructor Summary

Constructors

Constructor and Description
Field(String name)
Field(String name, DataType dataType) Constructor for header fields
Field(String name, DataType dataType, boolean isHeader) Creates a new field.
Field(String name, DataType dataType, boolean isHeader, DocumentType owner) Creates a new field.
Field(String name, Field field) Creates a field with a new name and the other properties (excluding the id and owner) copied from another field
Field(String name, int id, DataType dataType, boolean isHeader) Creates a new field.

Method Summary

Modifier and Type	Method and Description
private int	calculateIdV6(DocumentType owner) The field id must be unique within a document type, and also within a (unknown at this time) hierarchy of document types.
protected int	calculateIdV7(DocumentType owner) The field id must be unique within a document type, and also within a (unknown at this time) hierarchy of document types.
FieldSet	clone()
int	compareTo(Object o)
boolean	contains(FieldSet o)
boolean	equals(Object o) Two fields are equal if they have the same name and the same data type
DataType	getDataType()
int	getId()
int	getId(int version) Returns the numeric ID used to represent this field when serialized
int	getIdV6()
boolean	hasForcedId()
int	hashCode()
boolean	isHeader()
void	setDataType(DataType type) Deprecated. do not use
void	setHeader(boolean header) Sets whether this is a header field
void	setId(int newId, DocumentType owner) Sets the id of this field.
String	toString()
private void	validateId(int newId, DocumentType owner, int version)

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

getName

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

dataType

protected DataType dataType

fieldId

protected int fieldId

fieldIdV6

private int fieldIdV6

isHeader

private boolean isHeader

forcedId

private boolean forcedId

Constructor Detail

Field

public Field(String name,
             int id,
             DataType dataType,
             boolean isHeader)

Creates a new field.

Parameters:

name - The name of the field

dataType - The datatype of the field

isHeader - Whether this is a "header" field or a "content" field (true = "header").

Field

public Field(String name)

Field

public Field(String name,
             DataType dataType,
             boolean isHeader,
             DocumentType owner)

Creates a new field.

Parameters:

name - The name of the field

dataType - The datatype of the field

isHeader - Whether this is a "header" field or a "content" field (true = "header").

owner - the owning document (used to check for id collisions)

Field

public Field(String name,
             DataType dataType,
             boolean isHeader)

Creates a new field.

Parameters:

name - The name of the field

dataType - The datatype of the field

isHeader - Whether this is a "header" field or a "content" field (true = "header").

Field

public Field(String name,
             DataType dataType)

Constructor for header fields

Parameters:

name - The name of the field

dataType - The datatype of the field

Field

public Field(String name,
             Field field)

Creates a field with a new name and the other properties (excluding the id and owner) copied from another field

Method Detail

calculateIdV6

private int calculateIdV6(DocumentType owner)

The field id must be unique within a document type, and also within a (unknown at this time) hierarchy of document types. In addition it should be as resilient to doctype content changes and inheritance hierarchy changes as possible. All of this is enforced for names, so id's should follow names. Therefore we hash on name.

compareTo

public int compareTo(Object o)

Specified by:

compareTo in interface Comparable

calculateIdV7

protected int calculateIdV7(DocumentType owner)

The field id must be unique within a document type, and also within a (unknown at this time) hierarchy of document types. In addition it should be as resilient to doctype content changes and inheritance hierarchy changes as possible. All of this is enforced for names, so id's should follow names. Therefore we hash on name.

setId

public void setId(int newId,
                  DocumentType owner)

Sets the id of this field. Don't do this unless you know what you are doing

Parameters:

newId - the id - if this is less than 100 it will cause document to serialize using just one byte for this field id. 100-127 are reserved values

owner - the owning document, this is checked for collisions and notified of the id change. It can not be null

validateId

private void validateId(int newId,
                        DocumentType owner,
                        int version)

getDataType

public final DataType getDataType()

Returns:

Returns the datatype of the field

setDataType

@Deprecated
public void setDataType(DataType type)

Deprecated. do not use

Set the data type of the field. This will cause recalculation of fieldid for version 7+.

Parameters:

type - The new type of the field.

getId

public final int getId(int version)

Returns the numeric ID used to represent this field when serialized

getId

public final int getId()

getIdV6

public final int getIdV6()

hasForcedId

public final boolean hasForcedId()

Returns:

true if the field has a forced id

isHeader

public boolean isHeader()

Returns:

Returns true if this field should be a part of "header" serializations.

setHeader

public void setHeader(boolean header)

Sets whether this is a header field

equals

public boolean equals(Object o)

Two fields are equal if they have the same name and the same data type

Overrides:

equals in class com.yahoo.vespa.objects.FieldBase

hashCode

public int hashCode()

Overrides:

hashCode in class com.yahoo.vespa.objects.FieldBase

toString

public String toString()

Overrides:

toString in class com.yahoo.vespa.objects.FieldBase

contains

public boolean contains(FieldSet o)

Specified by:

contains in interface FieldSet

clone

public FieldSet clone()
               throws CloneNotSupportedException

Specified by:

clone in interface FieldSet

Overrides:

clone in class Object

Throws:

CloneNotSupportedException