Uses of Class
com.yahoo.document.Field

Packages that use Field

Package	Description
com.yahoo.document
com.yahoo.document.annotation	Provides classes and interfaces for creating trees of spans over string values in Vespa documents, and annotating these spans.
com.yahoo.document.datatypes
com.yahoo.document.json	Infrastructure for building Vespa documents and feed operations from JSON.
com.yahoo.document.json.readers
com.yahoo.document.update

Uses of Field in com.yahoo.document

Subclasses of Field in com.yahoo.document

Modifier and Type	Class	Description
class	ExtendedField	This adds an Extractor to the Field that can be used to access the backed value used in the concrete document types.
class	ExtendedStringField	This adds an Extractor to the ExtendedField that can be used to get access the backed spantrees used in the concrete document types.

Fields in com.yahoo.document with type parameters of type Field

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

Methods in com.yahoo.document that return Field

Modifier and Type	Method	Description
Field	DocumentType.addField(String name, DataType type)	Adds a new field to this document type and returns the new field object
Field	BaseStructDataType.getField(int id)
Field	BaseStructDataType.getField(String fieldName)
Field	Document.getField(String fieldName)
Field	DocumentType.getField(int id)
Field	DocumentType.getField(String name)	Gets the field matching a given name.
Field	StructDataType.getField(int id)
Field	StructDataType.getField(String fieldName)
abstract Field	StructuredDataType.getField(int id)	Gets the field with the specified id.
abstract Field	StructuredDataType.getField(String name)	Gets the field matching a given name.
Field	FieldPathEntry.getFieldRef()
Field	BaseStructDataType.removeField(String fieldName)
Field	DocumentType.removeField(String name)	Removes an field from the DocumentType.

Methods in com.yahoo.document that return types with arguments of type Field

Modifier and Type	Method	Description
Iterator<Field>	DocumentType.fieldIteratorThisTypeOnly()	Returns an iterator over all fields in this documenttype
Set<Field>	DocumentType.fieldSet()	Returns an ordered set snapshot of all fields of this documenttype, except the fields of Document.
Set<Field>	DocumentType.fieldSet(String name)
Set<Field>	DocumentType.fieldSetAll()	This is identical to DocumentType.fieldSet() fieldSet}, but in addition extra hidden synthetic fields are returned.
Collection<Field>	BaseStructDataType.getFields()
Collection<Field>	DocumentType.getFields()	All fields defined in the document and its parents This is for internal use Use DocumentType.fieldSet() instead or DocumentType.fieldSetAll() if you really want all fields
Collection<Field>	StructDataType.getFields()
abstract Collection<Field>	StructuredDataType.getFields()
Collection<Field>	StructDataType.getFieldsThisTypeOnly()
Iterator<Map.Entry<Field,FieldValue>>	Document.iterator()

Methods in com.yahoo.document with parameters of type Field

Modifier and Type	Method	Description
void	BaseStructDataType.addField(Field field)
void	DocumentType.addField(Field field)	Adds an field that can be used with this document type.
void	StructDataType.addField(Field field)
int	Field.compareTo(Field o)
void	Document.deserialize(Field field, FieldReader reader)
protected void	Document.doSetFieldValue(Field field, FieldValue value)
static Object	SimpleDocument.get(StructuredFieldValue struct, Field field)
final Object	SimpleDocument.get(Field field)
FieldUpdate	DocumentUpdate.getFieldUpdate(Field field)	Returns the update for a field
FieldValue	Document.getFieldValue(Field field)
boolean	BaseStructDataType.hasField(Field field)
static FieldPathEntry	FieldPathEntry.newStructFieldEntry(Field fieldRef)	Creates a new field path entry that references a struct field.
static Object	SimpleDocument.remove(StructuredFieldValue struct, Field field)
final Object	SimpleDocument.remove(Field field)
FieldUpdate	DocumentUpdate.removeFieldUpdate(Field field)
FieldValue	Document.removeFieldValue(Field field)
void	Document.serialize(Field field, FieldWriter writer)
static Object	SimpleDocument.set(StructuredFieldValue struct, Field field, Object value)
final Object	SimpleDocument.set(Field field, Object value)

Constructors in com.yahoo.document with parameters of type Field

Modifier	Constructor	Description
	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

Uses of Field in com.yahoo.document.annotation

Methods in com.yahoo.document.annotation with parameters of type Field

Modifier and Type	Method	Description
void	AnnotationReference.deserialize(Field field, FieldReader reader)
void	AnnotationReference.serialize(Field field, FieldWriter writer)

Uses of Field in com.yahoo.document.datatypes

Methods in com.yahoo.document.datatypes that return Field

Modifier and Type	Method	Description
Field	Struct.getField(String fieldName)
abstract Field	StructuredFieldValue.getField(String fieldName)	Returns the named field object, or null if that field does not exist.

Methods in com.yahoo.document.datatypes that return types with arguments of type Field

Modifier and Type	Method	Description
Set<Map.Entry<Field,FieldValue>>	Struct.getFields()
Iterator<Map.Entry<Field,FieldValue>>	Struct.iterator()
abstract Iterator<Map.Entry<Field,FieldValue>>	StructuredFieldValue.iterator()

Methods in com.yahoo.document.datatypes with parameters of type Field

Modifier and Type	Method	Description
void	Array.deserialize(Field field, FieldReader reader)
void	BoolFieldValue.deserialize(Field field, FieldReader reader)
void	ByteFieldValue.deserialize(Field field, FieldReader reader)
void	DoubleFieldValue.deserialize(Field field, FieldReader reader)
abstract void	FieldValue.deserialize(Field field, FieldReader reader)	Read a field value from the specified reader
void	Float16FieldValue.deserialize(Field field, FieldReader reader)
void	FloatFieldValue.deserialize(Field field, FieldReader reader)
void	IntegerFieldValue.deserialize(Field field, FieldReader reader)
void	LongFieldValue.deserialize(Field field, FieldReader reader)
void	MapFieldValue.deserialize(Field field, FieldReader reader)
void	PredicateFieldValue.deserialize(Field field, FieldReader reader)
void	Raw.deserialize(Field field, FieldReader reader)
void	ReferenceFieldValue.deserialize(Field field, FieldReader reader)
void	StringFieldValue.deserialize(Field field, FieldReader reader)
void	Struct.deserialize(Field field, FieldReader reader)
void	TensorFieldValue.deserialize(Field field, FieldReader reader)
void	UriFieldValue.deserialize(Field field, FieldReader reader)
void	WeightedSet.deserialize(Field field, FieldReader reader)
protected void	Struct.doSetFieldValue(Field field, FieldValue value)
protected abstract void	StructuredFieldValue.doSetFieldValue(Field field, FieldValue value)
static <T> T	Struct.getFieldValue(FieldValue struct, DataType structType, Field field, Class<T> fieldType)
FieldValue	Struct.getFieldValue(Field field)
abstract FieldValue	StructuredFieldValue.getFieldValue(Field field)	Returns the value of the given field.
FieldValue	Struct.removeFieldValue(Field field)
abstract FieldValue	StructuredFieldValue.removeFieldValue(Field field)	Removes and returns a field value.
void	Array.serialize(Field field, FieldWriter writer)
void	BoolFieldValue.serialize(Field field, FieldWriter writer)
void	ByteFieldValue.serialize(Field field, FieldWriter writer)
void	DoubleFieldValue.serialize(Field field, FieldWriter writer)
abstract void	FieldValue.serialize(Field field, FieldWriter writer)	Write out field value to the specified writer
void	Float16FieldValue.serialize(Field field, FieldWriter writer)
void	FloatFieldValue.serialize(Field field, FieldWriter writer)
void	IntegerFieldValue.serialize(Field field, FieldWriter writer)
void	LongFieldValue.serialize(Field field, FieldWriter writer)
void	MapFieldValue.serialize(Field field, FieldWriter writer)
void	PredicateFieldValue.serialize(Field field, FieldWriter writer)
void	Raw.serialize(Field field, FieldWriter writer)
void	ReferenceFieldValue.serialize(Field field, FieldWriter writer)
void	StringFieldValue.serialize(Field field, FieldWriter writer)
void	Struct.serialize(Field field, FieldWriter writer)
void	TensorFieldValue.serialize(Field field, FieldWriter writer)
void	WeightedSet.serialize(Field field, FieldWriter writer)
FieldValue	StructuredFieldValue.setFieldValue(Field field, FieldValue value)	Sets the value of the given field.
final FieldValue	StructuredFieldValue.setFieldValue(Field field, Byte value)
final FieldValue	StructuredFieldValue.setFieldValue(Field field, Double value)
final FieldValue	StructuredFieldValue.setFieldValue(Field field, Integer value)
final FieldValue	StructuredFieldValue.setFieldValue(Field field, Long value)
final FieldValue	StructuredFieldValue.setFieldValue(Field field, String value)

Uses of Field in com.yahoo.document.json

Fields in com.yahoo.document.json declared as Field

Modifier and Type	Field	Description
final Field	JsonReaderException.field

Methods in com.yahoo.document.json that return Field

Modifier and Type	Method	Description
Field	JsonReaderException.getField()

Constructors in com.yahoo.document.json with parameters of type Field

Modifier	Constructor	Description
	JsonReaderException(DocumentId docId, Field field, Throwable cause)
	JsonReaderException(Field field, Throwable cause)

Uses of Field in com.yahoo.document.json.readers

Methods in com.yahoo.document.json.readers with parameters of type Field

Modifier and Type	Method	Description
static void	AddRemoveCreator.createAdds(TokenBuffer buffer, Field field, FieldUpdate update, boolean ignoreUndefinedFields)
static ValueUpdate	MapReader.createMapUpdate(TokenBuffer buffer, Field field, boolean ignoreUndefinedFields)
static TensorModifyUpdate	TensorModifyUpdateReader.createModifyUpdate(TokenBuffer buffer, Field field)
static void	AddRemoveCreator.createRemoves(TokenBuffer buffer, Field field, FieldUpdate update, boolean ignoreUndefinedFields)
static TensorAddUpdate	TensorAddUpdateReader.createTensorAddUpdate(TokenBuffer buffer, Field field)
static boolean	TensorAddUpdateReader.isTensorField(Field field)

Uses of Field in com.yahoo.document.update

Fields in com.yahoo.document.update declared as Field

Modifier and Type	Field	Description
protected Field	FieldUpdate.field

Methods in com.yahoo.document.update that return Field

Modifier and Type	Method	Description
Field	FieldUpdate.getField()	Returns the field that this field update applies to

Methods in com.yahoo.document.update with parameters of type Field

Modifier and Type	Method	Description
static FieldUpdate	FieldUpdate.create(Field field)	Creates a new, empty field update with no encapsulated value updates.
static FieldUpdate	FieldUpdate.createAdd(Field field, FieldValue value)	Creates a new field update, with one encapsulated value update specifying an addition of a value to an array or a key to a weighted set (with default weight 1).
static FieldUpdate	FieldUpdate.createAdd(Field field, FieldValue key, Integer weight)	Creates a new field update, with one encapsulated value update specifying an addition of a key (with a specified weight) to a weighted set.
static FieldUpdate	FieldUpdate.createAddAll(Field field, WeightedSet<? extends FieldValue> set)	Creates a new field update, with encapsulated value updates, specifying an addition of all key/weight pairs in a weighted set to a weighted set.
static FieldUpdate	FieldUpdate.createAddAll(Field field, List<? extends FieldValue> values)	Creates a new field update, with encapsulated value updates, specifying an addition of all values in a given list to an array.
static FieldUpdate	FieldUpdate.createAssign(Field field, FieldValue newValue)	Creates a new field update, with one encapsulated value update, that assigns a new value, completely overwriting the previous value.
static FieldUpdate	FieldUpdate.createClear(Field field)	Creates a new field update, with one encapsulated value update, that clears the value; see documentation for ClearValueUpdate to see behavior for the individual data types.
static FieldUpdate	FieldUpdate.createClearField(Field field)	Creates a new field update that clears the field.
static FieldUpdate	FieldUpdate.createDecrement(Field field, FieldValue key, Number decrement)	Creates a new field update, with one encapsulated value update that decrements a weight in a weighted set.
static FieldUpdate	FieldUpdate.createDecrement(Field field, Number decrement)	Creates a new field update, with one encapsulated value update that decrements a value.
static FieldUpdate	FieldUpdate.createDivide(Field field, FieldValue key, Number divisor)	Creates a new field update, with one encapsulated value update that divides a weight in a weighted set.
static FieldUpdate	FieldUpdate.createDivide(Field field, Number divisor)	Creates a new field update, with one encapsulated value update that divides a value.
static FieldUpdate	FieldUpdate.createIncrement(Field field, FieldValue key, Number increment)	Creates a new field update, with one encapsulated value update that increments a weight in a weighted set.
static FieldUpdate	FieldUpdate.createIncrement(Field field, Number increment)	Creates a new field update, with one encapsulated value update that increments a value.
static FieldUpdate	FieldUpdate.createMap(Field field, FieldValue value, ValueUpdate update)	Creates a new field update, with one encapsulated value update, which is able to map an update to a value to a subvalue in an array or a weighted set.
static FieldUpdate	FieldUpdate.createMultiply(Field field, FieldValue key, Number factor)	Creates a new field update, with one encapsulated value update that multiplies a weight in a weighted set.
static FieldUpdate	FieldUpdate.createMultiply(Field field, Number factor)	Creates a new field update, with one encapsulated value update that multiplies a value.
static FieldUpdate	FieldUpdate.createRemove(Field field, FieldValue value)	Creates a new field update, with one encapsulated value update, specifying the removal of a value from an array or a key/weight from a weighted set.
static FieldUpdate	FieldUpdate.createRemoveAll(Field field, WeightedSet<? extends FieldValue> values)	Creates a new field update, with encapsulated value updates, specifying the removal of all values in a given list from an array or weighted set.
static FieldUpdate	FieldUpdate.createRemoveAll(Field field, List<? extends FieldValue> values)	Creates a new field update, with encapsulated value updates, specifying the removal of all values in a given list from an array or weighted set.
void	FieldUpdate.setField(Field field)	Sets the field this update applies to.