ORecordAbstract (OrientDB 2.2.37 API)

java.lang.Object
- com.orientechnologies.orient.core.record.ORecordAbstract

All Implemented Interfaces:

OIdentifiable, ORecordElement, ORecord, OSerializableStream, Serializable, Comparable<OIdentifiable>, Comparator<OIdentifiable>

Direct Known Subclasses:

ODocument, ORecordBytes, ORecordFlat
```
public abstract class ORecordAbstract
extends Object
implements ORecord
```
See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface com.orientechnologies.orient.core.db.record.ORecordElement
  ORecordElement.STATUS

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`_contentChanged`
`protected boolean`	`_dirty`
`protected ODirtyManager`	`_dirtyManager`
`protected Set<ORecordListener>`	`_listeners`
`protected ORecordSerializer`	`_recordFormat`
`protected ORecordId`	`_recordId`
`protected int`	`_recordVersion`
`protected int`	`_size`
`protected byte[]`	`_source`
`protected ORecordElement.STATUS`	`_status`

Constructor Summary

Constructors
Constructor and Description

ORecordAbstract()

ORecordAbstract(byte[] iSource)

Constructors
Constructor and Description
`ORecordAbstract()`
`ORecordAbstract(byte[] iSource)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addIdentityChangeListener(OIdentityChangeListener identityChangeListener)`
`protected void`	`addListener(ORecordListener iListener)` Add a listener to the current document to catch all the supported events.
`protected void`	`checkForLoading()`
`ORecordAbstract`	`clear()` All the fields are deleted but the record identity is maintained.
`protected void`	`clearSource()`
`int`	`compare(OIdentifiable iFirst, OIdentifiable iSecond)`
`int`	`compareTo(OIdentifiable iOther)`
`ORecordAbstract`	`copyTo(ORecordAbstract cloned)`
`ORecordAbstract`	`delete()` Deletes the record from the database.
`boolean`	`detach()` Removes all the dependencies with other records.
`boolean`	`equals(Object obj)`
`protected ORecordAbstract`	`fill(ORID iRid, int iVersion, byte[] iBuffer, boolean iDirty)`
`protected <RET extends ORecord> RET`	`flatCopy()`
`<RET extends ORecord> RET`	`fromJSON(InputStream iContentResult)`
`<RET extends ORecord> RET`	`fromJSON(String iSource)` Fills the record parsing the content in JSON format.
`<RET extends ORecord> RET`	`fromJSON(String iSource, boolean needReload)`
`<RET extends ORecord> RET`	`fromJSON(String iSource, String iOptions)`
`ORecordAbstract`	`fromStream(byte[] iRecordBuffer)` Unmarshalls the object.
`ODatabaseDocumentInternal`	`getDatabase()` Returns the database where the record belongs.
`ODatabaseDocument`	`getDatabaseIfDefined()`
`protected ODatabaseDocumentInternal`	`getDatabaseIfDefinedInternal()`
`protected ODatabaseDocumentInternal`	`getDatabaseInternal()`
`protected ODirtyManager`	`getDirtyManager()`
`ORID`	`getIdentity()` Returns the record identity as <cluster-id>:<cluster-position>
`ORecordElement.STATUS`	`getInternalStatus()` Returns the current status of the record.
`ORecordElement`	`getOwner()`
`ORecord`	`getRecord()` Returns the record instance.
`protected abstract byte`	`getRecordType()`
`int`	`getSize()` Returns the size in bytes of the record.
`int`	`getVersion()` Returns the current version number of the record.
`int`	`hashCode()`
`protected void`	`invokeListenerEvent(ORecordListener.EVENT iEvent)`
`protected boolean`	`isContentChanged()`
`boolean`	`isDirty()` Checks if the record is dirty, namely if it was changed in memory.
`boolean`	`isLocked()`
`ORecord`	`load()` Loads the record content in memory.
`void`	`lock(boolean iExclusive)`
`OStorage.LOCKING_STRATEGY`	`lockingStrategy()`
`protected void`	`onAfterIdentityChanged(ORecord iRecord)`
`protected void`	`onBeforeIdentityChanged(ORecord iRecord)`
`ORecord`	`reload()` Loads the record content in memory.
`ORecord`	`reload(String fetchPlan)`
`ORecord`	`reload(String fetchPlan, boolean ignoreCache)`
`ORecord`	`reload(String fetchPlan, boolean ignoreCache, boolean force)`
`protected void`	`removeIdentityChangeListener(OIdentityChangeListener identityChangeListener)`
`protected void`	`removeListener(ORecordListener listener)` Remove the current event listener.
`ORecordAbstract`	`reset()` Resets the record to be reused.
`ORecordAbstract`	`save()` Saves in-memory changes to the database.
`ORecordAbstract`	`save(boolean forceCreate)`
`ORecordAbstract`	`save(String iClusterName)` Saves in-memory changes to the database defining a specific cluster where to save it.
`ORecordAbstract`	`save(String iClusterName, boolean forceCreate)`
`protected void`	`setContentChanged(boolean contentChanged)`
`ORecordAbstract`	`setDirty()` Marks the instance as dirty.
`protected void`	`setDirtyManager(ODirtyManager dirtyManager)`
`void`	`setDirtyNoChanged()`
`protected ORecordAbstract`	`setIdentity(int iClusterId, long iClusterPosition)`
`protected ORecordAbstract`	`setIdentity(ORecordId iIdentity)`
`void`	`setInternalStatus(ORecordElement.STATUS iStatus)` Changes the current internal status.
`protected void`	`setup()`
`protected void`	`setVersion(int iVersion)`
`String`	`toJSON()` Exports the record in JSON format.
`void`	`toJSON(OutputStream stream)`
`String`	`toJSON(String iFormat)` Exports the record in JSON format specifying additional formatting settings.
`void`	`toJSON(String iFormat, OutputStream stream)`
`byte[]`	`toStream()` Marshalls the object.
`String`	`toString()`
`protected void`	`track(OIdentifiable id)`
`ORecordAbstract`	`unload()` Unloads current record.
`void`	`unlock()`
`protected void`	`unsetDirty()`
`protected void`	`unTrack(OIdentifiable id)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.orientechnologies.orient.core.record.ORecord
copy

Methods inherited from interface java.util.Comparator
comparing, comparing, comparingDouble, comparingInt, comparingLong, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

- Field Detail
  - _recordId
```
protected ORecordId _recordId
```
  - _recordVersion
```
protected int _recordVersion
```
  - _source
```
protected byte[] _source
```
  - _size
```
protected int _size
```
  - _recordFormat
```
protected transient ORecordSerializer _recordFormat
```
  - _dirty
```
protected boolean _dirty
```
  - _contentChanged
```
protected boolean _contentChanged
```
  - _status
```
protected ORecordElement.STATUS _status
```
  - _listeners
```
protected transient Set<ORecordListener> _listeners
```
  - _dirtyManager
```
protected ODirtyManager _dirtyManager
```
- Constructor Detail
  - ORecordAbstract
```
public ORecordAbstract()
```
  - ORecordAbstract
```
public ORecordAbstract(byte[] iSource)
```
- Method Detail
  - getIdentity
```
public ORID getIdentity()
```
    Description copied from interface: ORecord
    
    Returns the record identity as <cluster-id>:<cluster-position>
    
    Specified by:
    
    getIdentity in interface OIdentifiable
    
    Specified by:
    
    getIdentity in interface ORecord
    
    Returns:
    
    ORID instance
  - setIdentity
```
protected ORecordAbstract setIdentity(ORecordId iIdentity)
```
  - getOwner
```
public ORecordElement getOwner()
```
    Specified by:
    
    getOwner in interface ORecordElement
    
    Returns:
    
    Returns record element which contains given one.
  - getRecord
```
public ORecord getRecord()
```
    Description copied from interface: OIdentifiable
    
    Returns the record instance.
    
    Specified by:
    
    getRecord in interface OIdentifiable
    
    Returns:
    
    ORecord instance
  - detach
```
public boolean detach()
```
    Description copied from interface: ORecord
    
    Removes all the dependencies with other records. All the relationships remain in form of RecordID. If some links contain dirty records, the detach cannot be complete and this method returns false.
    
    Specified by:
    
    detach in interface ORecord
    
    Returns:
    
    True if the document has been successfully detached, otherwise false.
  - clear
```
public ORecordAbstract clear()
```
    Description copied from interface: ORecord
    
    All the fields are deleted but the record identity is maintained. Use this to remove all the document's fields.
    
    Specified by:
    
    clear in interface ORecord
    
    Returns:
    
    The Object instance itself giving a "fluent interface". Useful to call multiple methods in chain.
  - reset
```
public ORecordAbstract reset()
```
    Description copied from interface: ORecord
    
    Resets the record to be reused. The record is fresh like just created. Use this method to recycle records avoiding the creation of them stressing the JVM Garbage Collector.
    
    Specified by:
    
    reset in interface ORecord
    
    Returns:
    
    The Object instance itself giving a "fluent interface". Useful to call multiple methods in chain.
  - toStream
```
public byte[] toStream()
```
    Description copied from interface: OSerializableStream
    
    Marshalls the object. Transforms the current object in byte[] form to being stored or transferred over the network.
    
    Specified by:
    
    toStream in interface OSerializableStream
    
    Returns:
    
    The byte array representation of the object
    
    See Also:
    
    OSerializableStream.fromStream(byte[])
  - fromStream
```
public ORecordAbstract fromStream(byte[] iRecordBuffer)
```
    Description copied from interface: OSerializableStream
    
    Unmarshalls the object. Fills the current object with the values contained in the byte array representation restoring a previous state. Usually byte[] comes from the storage or network.
    
    Specified by:
    
    fromStream in interface OSerializableStream
    
    Parameters:
    
    iRecordBuffer - byte array representation of the object
    
    Returns:
    
    The Object instance itself giving a "fluent interface". Useful to call multiple methods in chain.
  - setDirty
```
public ORecordAbstract setDirty()
```
    Description copied from interface: ORecordElement
    
    Marks the instance as dirty. The dirty status could be propagated up if the implementation supports ownership concept.
    
    Specified by:
    
    setDirty in interface ORecordElement
    
    Returns:
    
    The object it self. Useful to call methods in chain.
  - setDirtyNoChanged
```
public void setDirtyNoChanged()
```
    Specified by:
    
    setDirtyNoChanged in interface ORecordElement
  - isDirty
```
public boolean isDirty()
```
    Description copied from interface: ORecord
    
    Checks if the record is dirty, namely if it was changed in memory.
    
    Specified by:
    
    isDirty in interface ORecord
    
    Returns:
    
    True if dirty, otherwise false
  - fromJSON
```
public <RET extends ORecord> RET fromJSON(String iSource,
                                          String iOptions)
```
  - fromJSON
```
public <RET extends ORecord> RET fromJSON(String iSource)
```
    Description copied from interface: ORecord
    
    Fills the record parsing the content in JSON format.
    
    Specified by:
    
    fromJSON in interface ORecord
    
    Parameters:
    
    iSource - Object content in JSON format
    
    Returns:
    
    The Object instance itself giving a "fluent interface". Useful to call multiple methods in chain.
  - fromJSON
```
public <RET extends ORecord> RET fromJSON(String iSource,
                                          boolean needReload)
```
  - fromJSON
```
public <RET extends ORecord> RET fromJSON(InputStream iContentResult)
                                   throws IOException
```
    Throws:
    
    IOException
  - toJSON
```
public String toJSON()
```
    Description copied from interface: ORecord
    
    Exports the record in JSON format.
    
    Specified by:
    
    toJSON in interface ORecord
    
    Returns:
    
    Object content in JSON format
  - toJSON
```
public String toJSON(String iFormat)
```
    Description copied from interface: ORecord
    
    Exports the record in JSON format specifying additional formatting settings.
    Specified by:
    
    toJSON in interface ORecord
    
    Parameters:
    iFormat - Format settings separated by comma. Available settings are:
    
    rid: exports the record's id as property "@rid"
    
    version: exports the record's version as property "@version"
    
    class: exports the record's class as property "@class"
    
    attribSameRow: exports all the record attributes in the same row
    
    indent:<level>: Indents the output if the <level> specified. Default is 0
    
    Example: "rid,version,class,indent:6" exports record id, version and class properties along with record properties using an indenting level equals of 6.
    Returns:
    
    Object content in JSON format
  - toJSON
```
public void toJSON(String iFormat,
                   OutputStream stream)
            throws IOException
```
    Throws:
    
    IOException
  - toJSON
```
public void toJSON(OutputStream stream)
            throws IOException
```
    Throws:
    
    IOException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getVersion
```
public int getVersion()
```
    Description copied from interface: ORecord
    
    Returns the current version number of the record. When the record is created has version = 0. At every change the storage increment the version number. Version number is used by Optimistic transactions to check if the record is changed in the meanwhile of the transaction.
    
    Specified by:
    
    getVersion in interface ORecord
    
    Returns:
    
    The version number. 0 if it's a brand new record.
    
    See Also:
    
    OTransactionOptimistic
  - setVersion
```
protected void setVersion(int iVersion)
```
  - unload
```
public ORecordAbstract unload()
```
    Description copied from interface: ORecord
    
    Unloads current record. All information are lost but the record identity. At the next access the record will be auto-reloaded. Useful to free memory or to avoid to keep an old version of it.
    
    Specified by:
    
    unload in interface ORecord
    
    Returns:
    
    The Object instance itself giving a "fluent interface". Useful to call multiple methods in chain.
  - load
```
public ORecord load()
```
    Description copied from interface: ORecord
    
    Loads the record content in memory. If the record is in cache will be returned a new instance, so pay attention to use the returned. If the record is dirty, then it returns to the original content. If the record does not exist a ORecordNotFoundException exception is thrown.
    
    Specified by:
    
    load in interface ORecord
    
    Returns:
    
    The record loaded or itself if the record has been reloaded from the storage. Useful to call methods in chain.
  - getDatabase
```
public ODatabaseDocumentInternal getDatabase()
```
    Description copied from interface: ORecord
    
    Returns the database where the record belongs.
    
    Specified by:
    
    getDatabase in interface ORecord
    
    Returns:
  - getDatabaseIfDefined
```
public ODatabaseDocument getDatabaseIfDefined()
```
  - reload
```
public ORecord reload()
```
    Description copied from interface: ORecord
    
    Loads the record content in memory. No cache is used. If the record is dirty, then it returns to the original content. If the record does not exist a ORecordNotFoundException exception is thrown.
    
    Specified by:
    
    reload in interface ORecord
    
    Returns:
    
    The Object instance itself giving a "fluent interface". Useful to call multiple methods in chain.
  - reload
```
public ORecord reload(String fetchPlan)
```
  - reload
```
public ORecord reload(String fetchPlan,
                      boolean ignoreCache)
```
  - reload
```
public ORecord reload(String fetchPlan,
                      boolean ignoreCache,
                      boolean force)
               throws ORecordNotFoundException
```
    Specified by:
    
    reload in interface ORecord
    
    Throws:
    
    ORecordNotFoundException
  - save
```
public ORecordAbstract save()
```
    Description copied from interface: ORecord
    
    Saves in-memory changes to the database. Behavior depends by the current running transaction if any. If no transaction is running then changes apply immediately. If an Optimistic transaction is running then the record will be changed at commit time. The current transaction will continue to see the record as modified, while others not. If a Pessimistic transaction is running, then an exclusive lock is acquired against the record. Current transaction will continue to see the record as modified, while others cannot access to it since it's locked.
    
    Specified by:
    
    save in interface ORecord
    
    Returns:
    
    The Object instance itself giving a "fluent interface". Useful to call multiple methods in chain.
  - save
```
public ORecordAbstract save(String iClusterName)
```
    Description copied from interface: ORecord
    
    Saves in-memory changes to the database defining a specific cluster where to save it. Behavior depends by the current running transaction if any. If no transaction is running then changes apply immediately. If an Optimistic transaction is running then the record will be changed at commit time. The current transaction will continue to see the record as modified, while others not. If a Pessimistic transaction is running, then an exclusive lock is acquired against the record. Current transaction will continue to see the record as modified, while others cannot access to it since it's locked.
    
    Specified by:
    
    save in interface ORecord
    
    Returns:
    
    The Object instance itself giving a "fluent interface". Useful to call multiple methods in chain.
  - save
```
public ORecordAbstract save(boolean forceCreate)
```
    Specified by:
    
    save in interface ORecord
  - save
```
public ORecordAbstract save(String iClusterName,
                            boolean forceCreate)
```
    Specified by:
    
    save in interface ORecord
  - delete
```
public ORecordAbstract delete()
```
    Description copied from interface: ORecord
    
    Deletes the record from the database. Behavior depends by the current running transaction if any. If no transaction is running then the record is deleted immediately. If an Optimistic transaction is running then the record will be deleted at commit time. The current transaction will continue to see the record as deleted, while others not. If a Pessimistic transaction is running, then an exclusive lock is acquired against the record. Current transaction will continue to see the record as deleted, while others cannot access to it since it's locked.
    
    Specified by:
    
    delete in interface ORecord
    
    Returns:
    
    The Object instance itself giving a "fluent interface". Useful to call multiple methods in chain.
  - getSize
```
public int getSize()
```
    Description copied from interface: ORecord
    
    Returns the size in bytes of the record. The size can be computed only for not new records.
    
    Specified by:
    
    getSize in interface ORecord
    
    Returns:
    
    the size in bytes
  - lock
```
public void lock(boolean iExclusive)
```
    Specified by:
    
    lock in interface OIdentifiable
  - isLocked
```
public boolean isLocked()
```
    Specified by:
    
    isLocked in interface OIdentifiable
  - lockingStrategy
```
public OStorage.LOCKING_STRATEGY lockingStrategy()
```
    Specified by:
    
    lockingStrategy in interface OIdentifiable
  - unlock
```
public void unlock()
```
    Specified by:
    
    unlock in interface OIdentifiable
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Specified by:
    
    equals in interface Comparator<OIdentifiable>
    
    Overrides:
    
    equals in class Object
  - compare
```
public int compare(OIdentifiable iFirst,
                   OIdentifiable iSecond)
```
    Specified by:
    
    compare in interface Comparator<OIdentifiable>
  - compareTo
```
public int compareTo(OIdentifiable iOther)
```
    Specified by:
    
    compareTo in interface Comparable<OIdentifiable>
  - getInternalStatus
```
public ORecordElement.STATUS getInternalStatus()
```
    Description copied from interface: ORecordElement
    
    Returns the current status of the record.
    
    Specified by:
    
    getInternalStatus in interface ORecordElement
    
    Returns:
    
    Current status as value between the defined values in the enum ORecordElement.STATUS
  - setInternalStatus
```
public void setInternalStatus(ORecordElement.STATUS iStatus)
```
    Description copied from interface: ORecordElement
    
    Changes the current internal status.
    
    Specified by:
    
    setInternalStatus in interface ORecordElement
    
    Parameters:
    
    iStatus - status between the values defined in the enum ORecordElement.STATUS
  - copyTo
```
public ORecordAbstract copyTo(ORecordAbstract cloned)
```
  - fill
```
protected ORecordAbstract fill(ORID iRid,
                               int iVersion,
                               byte[] iBuffer,
                               boolean iDirty)
```
  - setIdentity
```
protected ORecordAbstract setIdentity(int iClusterId,
                                      long iClusterPosition)
```
  - unsetDirty
```
protected void unsetDirty()
```
  - getRecordType
```
protected abstract byte getRecordType()
```
  - onBeforeIdentityChanged
```
protected void onBeforeIdentityChanged(ORecord iRecord)
```
  - onAfterIdentityChanged
```
protected void onAfterIdentityChanged(ORecord iRecord)
```
  - getDatabaseInternal
```
protected ODatabaseDocumentInternal getDatabaseInternal()
```
  - getDatabaseIfDefinedInternal
```
protected ODatabaseDocumentInternal getDatabaseIfDefinedInternal()
```
  - addListener
```
protected void addListener(ORecordListener iListener)
```
    Add a listener to the current document to catch all the supported events.
    
    Parameters:
    
    iListener - ODocumentListener implementation
    
    See Also:
    
    ju
  - removeListener
```
protected void removeListener(ORecordListener listener)
```
    Remove the current event listener.
    
    See Also:
    
    ORecordListener
  - flatCopy
```
protected <RET extends ORecord> RET flatCopy()
```
  - addIdentityChangeListener
```
protected void addIdentityChangeListener(OIdentityChangeListener identityChangeListener)
```
  - removeIdentityChangeListener
```
protected void removeIdentityChangeListener(OIdentityChangeListener identityChangeListener)
```
  - setup
```
protected void setup()
```
  - invokeListenerEvent
```
protected void invokeListenerEvent(ORecordListener.EVENT iEvent)
```
  - checkForLoading
```
protected void checkForLoading()
```
  - isContentChanged
```
protected boolean isContentChanged()
```
  - setContentChanged
```
protected void setContentChanged(boolean contentChanged)
```
  - clearSource
```
protected void clearSource()
```
  - getDirtyManager
```
protected ODirtyManager getDirtyManager()
```
  - setDirtyManager
```
protected void setDirtyManager(ODirtyManager dirtyManager)
```
  - track
```
protected void track(OIdentifiable id)
```
  - unTrack
```
protected void unTrack(OIdentifiable id)
```

Class ORecordAbstract

Nested Class Summary

Nested classes/interfaces inherited from interface com.orientechnologies.orient.core.db.record.ORecordElement

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.orientechnologies.orient.core.record.ORecord

Methods inherited from interface java.util.Comparator

Field Detail

_recordId

_recordVersion

_source

_size

_recordFormat

_dirty

_contentChanged

_status

_listeners

_dirtyManager

Constructor Detail

ORecordAbstract

ORecordAbstract

Method Detail

getIdentity

setIdentity

getOwner

getRecord

detach

clear

reset

toStream

fromStream

setDirty

setDirtyNoChanged

isDirty

fromJSON

fromJSON

fromJSON

fromJSON

toJSON

toJSON

toJSON

toJSON

toString

getVersion

setVersion

unload

load

getDatabase

getDatabaseIfDefined

reload

reload

reload

reload

save

save

save

save

delete

getSize

lock

isLocked

lockingStrategy

unlock

hashCode

equals

compare

compareTo

getInternalStatus

setInternalStatus

copyTo

fill

setIdentity

unsetDirty

getRecordType

onBeforeIdentityChanged

onAfterIdentityChanged

getDatabaseInternal

getDatabaseIfDefinedInternal