public class Document extends StructuredFieldValue
document type
.
A document represents an instance of some entity of interest
in an application, like an article, a web document, a product, etc.
Deprecation: Try to use document set and get methods only with FieldValue types,
not with primitive types. Support for direct access to primitive types will
be removed soon.Modifier and Type | Field and Description |
---|---|
private Struct |
body |
static int |
classId |
private DocumentId |
docId |
private Struct |
header |
private Long |
lastModified |
static short |
SERIALIZED_VERSION |
Constructor and Description |
---|
Document(Document doc)
Creates a document that is a shallow copy of another.
|
Document(DocumentReader reader) |
Document(DocumentType docType,
DocumentId id)
Create a document with the given document type and identifier.
|
Document(DocumentType docType,
String id)
Create a document with the given document type and identifier.
|
Modifier and Type | Method and Description |
---|---|
void |
assign(Object o)
Assign this non-fieldvalue value to this field value.
|
void |
clear() |
Document |
clone() |
int |
compareTo(FieldValue fieldValue) |
static Document |
createDocument(DocumentReader buffer) |
void |
deserialize(DocumentReader reader) |
void |
deserialize(Field field,
FieldReader reader)
Read a field value from the specified reader
|
protected void |
doSetFieldValue(Field field,
FieldValue value) |
boolean |
equals(Object o)
Returns true if the argument is a document which has the same set of values
|
int |
getApproxSize()
This is an approximation of serialized size.
|
Struct |
getBody() |
DocumentType |
getDataType() |
Field |
getField(String fieldName)
Returns the named field object, or null if that field does not exist.
|
int |
getFieldCount() |
FieldValue |
getFieldValue(Field field)
Returns the value of the given field.
|
Struct |
getHeader() |
DocumentId |
getId() |
Long |
getLastModified()
Returns the last modified time of this Document, when stored in persistent storage.
|
int |
getSerializedSize() |
int |
hashCode() |
private void |
internalSetId(DocumentId id,
DocumentType docType) |
Iterator<Map.Entry<Field,FieldValue>> |
iterator() |
void |
onSerialize(com.yahoo.vespa.objects.Serializer data) |
void |
printXml(XmlStream xml) |
FieldValue |
removeFieldValue(Field field)
Removes and returns a field value.
|
void |
serialize(DocumentWriter writer) |
void |
serialize(Field field,
FieldWriter writer)
Write out field value to the specified writer
|
void |
serialize(OutputStream out) |
void |
serializeBody(com.yahoo.vespa.objects.Serializer data) |
void |
serializeHeader(com.yahoo.vespa.objects.Serializer data) |
void |
setDataType(DataType type) |
void |
setId(DocumentId id) |
void |
setLastModified(Long lastModified)
Sets the last modified time of this Document.
|
private void |
setNewType(DocumentType type) |
String |
toString() |
String |
toXml()
Get XML representation of the document root and its children, contained
within a <document></document> tag.
|
String |
toXML(String indent) |
getFieldValue, isGenerated, iterateNested, removeFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue
create, deserialize, getRecursiveValue, getRecursiveValue, getWrappedValue, onDeserialize, serialize
public static final int classId
public static final short SERIALIZED_VERSION
private DocumentId docId
private Struct header
private Struct body
private Long lastModified
public Document(DocumentType docType, String id)
docType
- DocumentType to use for creationid
- The id for this documentpublic Document(DocumentType docType, DocumentId id)
docType
- DocumentType to use for creationid
- The id for this documentpublic Document(Document doc)
doc
- The document to copy.public Document(DocumentReader reader)
reader
- The deserializer to use for creating this documentpublic DocumentId getId()
public void setId(DocumentId id)
private void internalSetId(DocumentId id, DocumentType docType)
public Struct getHeader()
public Struct getBody()
public void assign(Object o)
FieldValue
Override to accept the specific types that should be legal.
assign
in class FieldValue
public Document clone()
clone
in class FieldValue
private void setNewType(DocumentType type)
public void setDataType(DataType type)
setDataType
in class CompositeFieldValue
public int getSerializedSize() throws SerializationException
SerializationException
public final int getApproxSize()
public void serialize(OutputStream out) throws SerializationException
SerializationException
public static Document createDocument(DocumentReader buffer)
public Field getField(String fieldName)
StructuredFieldValue
getField
in class StructuredFieldValue
fieldName
- The name of the field to return.public FieldValue getFieldValue(Field field)
StructuredFieldValue
getFieldValue
in class StructuredFieldValue
field
- The field whose value to return.protected void doSetFieldValue(Field field, FieldValue value)
doSetFieldValue
in class StructuredFieldValue
public FieldValue removeFieldValue(Field field)
StructuredFieldValue
removeFieldValue
in class StructuredFieldValue
field
- The field whose value to remove.public void clear()
clear
in class StructuredFieldValue
public Iterator<Map.Entry<Field,FieldValue>> iterator()
iterator
in class StructuredFieldValue
public String toString()
toString
in class com.yahoo.vespa.objects.Identifiable
public String toXml()
toXml
in class FieldValue
public void printXml(XmlStream xml)
printXml
in class FieldValue
public boolean equals(Object o)
equals
in class CompositeFieldValue
public int hashCode()
hashCode
in class CompositeFieldValue
public Long getLastModified()
public void setLastModified(Long lastModified)
lastModified
- the last modified time of this Document (in milliseconds)public void onSerialize(com.yahoo.vespa.objects.Serializer data) throws SerializationException
onSerialize
in class FieldValue
SerializationException
public void serializeHeader(com.yahoo.vespa.objects.Serializer data) throws SerializationException
SerializationException
public void serializeBody(com.yahoo.vespa.objects.Serializer data) throws SerializationException
SerializationException
public DocumentType getDataType()
getDataType
in class StructuredFieldValue
public int getFieldCount()
getFieldCount
in class StructuredFieldValue
public void serialize(DocumentWriter writer)
public void deserialize(DocumentReader reader)
public void serialize(Field field, FieldWriter writer)
FieldValue
serialize
in class FieldValue
public void deserialize(Field field, FieldReader reader)
FieldValue
deserialize
in class FieldValue
public int compareTo(FieldValue fieldValue)
compareTo
in interface Comparable<FieldValue>
compareTo
in class FieldValue
Copyright © 2018. All rights reserved.