Package com.arcadedb.database

Class BaseDocument

java.lang.Object

com.arcadedb.database.BaseRecord

com.arcadedb.database.BaseDocument

All Implemented Interfaces:

Document, Identifiable, Record, Externalizable, Serializable

Direct Known Subclasses:

ImmutableDocument, MutableDocument

public abstract class BaseDocument
extends BaseRecord
implements Document, Serializable, Externalizable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	propertiesStartingPosition
protected DocumentType	type

Fields inherited from class com.arcadedb.database.BaseRecord

buffer, database, rid

Fields inherited from interface com.arcadedb.database.Document

RECORD_TYPE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseDocument(Database database, DocumentType type, RID rid, Binary buffer)

Method Summary

Modifier and Type	Method	Description
Document	asDocument()	Returns the document record.
Document	asDocument(boolean loadContent)	Returns the document record.
DetachedDocument	detach()
Boolean	getBoolean(String propertyName)
Byte	getByte(String propertyName)
Date	getDate(String propertyName)
BigDecimal	getDecimal(String propertyName)
Double	getDouble(String propertyName)
EmbeddedDocument	getEmbedded(String propertyName)
Float	getFloat(String propertyName)
Integer	getInteger(String propertyName)
Long	getLong(String propertyName)
byte	getRecordType()
Short	getShort(String propertyName)
String	getString(String propertyName)
DocumentType	getType()
String	getTypeName()
void	readExternal(ObjectInput in)
void	reload()
void	writeExternal(ObjectOutput out)

Methods inherited from class com.arcadedb.database.BaseRecord

asEdge, asEdge, asVertex, asVertex, delete, equals, getBuffer, getDatabase, getIdentity, getRecord, getRecord, hashCode, setBuffer, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.arcadedb.database.Document

get, getPropertyNames, has, modify, toJSON, toMap

Methods inherited from interface com.arcadedb.database.Identifiable

asEdge, asEdge, asVertex, asVertex, getRecord, getRecord

Methods inherited from interface com.arcadedb.database.Record

delete, getDatabase, getIdentity

Field Detail

type

protected final DocumentType type

propertiesStartingPosition

protected int propertiesStartingPosition

Constructor Detail

BaseDocument

protected BaseDocument(Database database,
                       DocumentType type,
                       RID rid,
                       Binary buffer)

Method Detail

asDocument

public Document asDocument()

Description copied from interface: Identifiable

Returns the document record. If the record is not a document, a UnsupportedOperationException exception is thrown.

Specified by:

asDocument in interface Document

Specified by:

asDocument in interface Identifiable

Overrides:

asDocument in class BaseRecord

Returns:

the Document

asDocument

public Document asDocument(boolean loadContent)

Description copied from interface: Identifiable

Returns the document record. If the record is not a document, a UnsupportedOperationException exception is thrown.

Specified by:

asDocument in interface Document

Specified by:

asDocument in interface Identifiable

Overrides:

asDocument in class BaseRecord

Parameters:

loadContent - specifies if pre-load the record content

Returns:

the Document

detach

public DetachedDocument detach()

Specified by:

detach in interface Document

getString

public String getString(String propertyName)

Specified by:

getString in interface Document

getBoolean

public Boolean getBoolean(String propertyName)

Specified by:

getBoolean in interface Document

getByte

public Byte getByte(String propertyName)

Specified by:

getByte in interface Document

getShort

public Short getShort(String propertyName)

Specified by:

getShort in interface Document

getInteger

public Integer getInteger(String propertyName)

Specified by:

getInteger in interface Document

getLong

public Long getLong(String propertyName)

Specified by:

getLong in interface Document

getFloat

public Float getFloat(String propertyName)

Specified by:

getFloat in interface Document

getDouble

public Double getDouble(String propertyName)

Specified by:

getDouble in interface Document

getDecimal

public BigDecimal getDecimal(String propertyName)

Specified by:

getDecimal in interface Document

getDate

public Date getDate(String propertyName)

Specified by:

getDate in interface Document

getEmbedded

public EmbeddedDocument getEmbedded(String propertyName)

Specified by:

getEmbedded in interface Document

getType

public DocumentType getType()

Specified by:

getType in interface Document

getTypeName

public String getTypeName()

Specified by:

getTypeName in interface Document

getRecordType

public byte getRecordType()

Specified by:

getRecordType in interface Record

reload

public void reload()

Specified by:

reload in interface Record

Overrides:

reload in class BaseRecord

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException