ORidBag (OrientDB 3.1.2-SNAPSHOT API)

java.lang.Object
- com.orientechnologies.orient.core.db.record.ridbag.ORidBag

All Implemented Interfaces:

OCollection<OIdentifiable>, OSizeable, OAutoConvertToRecord, ODetachable, ORecordElement, ORecordLazyMultiValue, OTrackedMultiValue<OIdentifiable,OIdentifiable>, OStringBuilderSerializable, Iterable<OIdentifiable>
```
public class ORidBag
extends Object
implements OStringBuilderSerializable, Iterable<OIdentifiable>, ORecordLazyMultiValue, OTrackedMultiValue<OIdentifiable,OIdentifiable>, OCollection<OIdentifiable>, ORecordElement
```
A collection that contain links to OIdentifiable. Bag is similar to set but can contain several entering of the same object.

Could be tree based and embedded representation.
- Embedded stores its content directly to the document that owns it.
  It better fits for cases when only small amount of links are stored to the bag.
- Tree-based implementation stores its content in a separate data structure called OSBTreeBonsai.
  It fits great for cases when you have a huge amount of links.
The representation is automatically converted to tree-based implementation when top threshold is reached. And backward to embedded one when size is decreased to bottom threshold.
The thresholds could be configured by OGlobalConfiguration.RID_BAG_EMBEDDED_TO_SBTREEBONSAI_THRESHOLD and OGlobalConfiguration.RID_BAG_SBTREEBONSAI_TO_EMBEDDED_THRESHOLD.

This collection is used to efficiently manage relationships in graph model.

Does not implement Collection interface because some operations could not be efficiently implemented and that's why should be avoided.
Since:

1.7rc1

Author:

Artem Orobets (enisher-at-gmail.com), Andrey Lomakin (a.lomakin-at-orientdb.com)

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

Constructor Summary

Constructors
Constructor and Description
`ORidBag()`
`ORidBag(int iTopThreshold, int iBottomThreshold)`
`ORidBag(OBonsaiCollectionPointer pointer, Map<OIdentifiable,Change> changes, UUID uuid)`
`ORidBag(ORidBag ridBag)`
`ORidBag(ORidBagDelegate delegate)`
`ORidBag(UUID uuid)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(OIdentifiable identifiable)`
`void`	`addAll(Collection<OIdentifiable> values)`
`void`	`checkAndConvert()`
`boolean`	`contains(OIdentifiable identifiable)` THIS IS VERY EXPENSIVE METHOD AND CAN NOT BE CALLED IN REMOTE STORAGE.
`void`	`convertLinks2Records()` Browse all the set to convert all the items into records.
`boolean`	`convertRecords2Links()` Browse all the set to convert all the items into links.
`ORidBag`	`copy()`
`void`	`debugPrint(PrintStream writer)`
`void`	`delete()`
`boolean`	`detach()` Detaches the object.
`void`	`disableTracking(ORecordElement document)`
`void`	`enableTracking(ORecordElement parent)`
`boolean`	`equals(Object other)`
`void`	`fromStream(byte[] stream)`
`void`	`fromStream(BytesContainer stream)`
`static ORidBag`	`fromStream(String value)`
`OStringBuilderSerializable`	`fromStream(StringBuilder input)`
`NavigableMap<OIdentifiable,Change>`	`getChanges()`
`ORidBagDelegate`	`getDelegate()`
`Class<?>`	`getGenericClass()`
`ORecordElement`	`getOwner()`
`OBonsaiCollectionPointer`	`getPointer()`
`UUID`	`getTemporaryId()` Temporary id of collection to track changes in remote mode.
`OMultiValueChangeTimeLine<Object,Object>`	`getTimeLine()`
`OMultiValueChangeTimeLine<OIdentifiable,OIdentifiable>`	`getTransactionTimeLine()`
`protected void`	`init()`
`boolean`	`isAutoConvertToRecord()`
`boolean`	`isEmbedded()`
`boolean`	`isEmpty()`
`boolean`	`isModified()`
`boolean`	`isToSerializeEmbedded()`
`boolean`	`isTransactionModified()`
`Iterator<OIdentifiable>`	`iterator()`
`void`	`makeEmbedded()`
`void`	`makeTree()`
`void`	`notifySaved(OBonsaiCollectionPointer newPointer)` Notify collection that changes has been saved.
`Iterator<OIdentifiable>`	`rawIterator()`
`void`	`remove(OIdentifiable identifiable)`
`void`	`replace(OMultiValueChangeEvent<Object,Object> event, Object newValue)`
`Object`	`returnOriginalState(List<OMultiValueChangeEvent<OIdentifiable,OIdentifiable>> multiValueChangeEvents)` Reverts all operations that were performed on collection and return original collection state.
`void`	`setAutoConvertToRecord(boolean convertToRecord)`
`<RET> RET`	`setDirty()` Marks the instance as dirty.
`void`	`setDirtyNoChanged()`
`void`	`setOwner(ORecordElement owner)`
`void`	`setRecordAndField(ORecordId id, String fieldName)`
`void`	`setTemporaryId(UUID uuid)`
`int`	`size()`
`int`	`toStream(BytesContainer bytesContainer)`
`OStringBuilderSerializable`	`toStream(StringBuilder output)`
`String`	`toString()`
`void`	`transactionClear()`
`boolean`	`tryMerge(ORidBag otherValue, boolean iMergeSingleItemsOfMultiValueFields)` IMPORTANT! Only for internal usage.

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

Methods inherited from interface com.orientechnologies.orient.core.db.record.OTrackedMultiValue
nestedDisable, nestedEnabled, nestedTransactionClear

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - ORidBag
```
public ORidBag(ORidBag ridBag)
```
  - ORidBag
```
public ORidBag()
```
  - ORidBag
```
public ORidBag(int iTopThreshold,
               int iBottomThreshold)
```
  - ORidBag
```
public ORidBag(UUID uuid)
```
  - ORidBag
```
public ORidBag(OBonsaiCollectionPointer pointer,
               Map<OIdentifiable,Change> changes,
               UUID uuid)
```
  - ORidBag
```
public ORidBag(ORidBagDelegate delegate)
```
- Method Detail
  - fromStream
```
public static ORidBag fromStream(String value)
```
  - copy
```
public ORidBag copy()
```
  - contains
```
public boolean contains(OIdentifiable identifiable)
```
    THIS IS VERY EXPENSIVE METHOD AND CAN NOT BE CALLED IN REMOTE STORAGE.
    
    Parameters:
    
    identifiable - Object to check.
    
    Returns:
    
    true if ridbag contains at leas one instance with the same rid as passed in identifiable.
  - addAll
```
public void addAll(Collection<OIdentifiable> values)
```
  - add
```
public void add(OIdentifiable identifiable)
```
    Specified by:
    
    add in interface OCollection<OIdentifiable>
  - remove
```
public void remove(OIdentifiable identifiable)
```
    Specified by:
    
    remove in interface OCollection<OIdentifiable>
  - isEmpty
```
public boolean isEmpty()
```
  - iterator
```
public Iterator<OIdentifiable> iterator()
```
    Specified by:
    
    iterator in interface Iterable<OIdentifiable>
  - rawIterator
```
public Iterator<OIdentifiable> rawIterator()
```
    Specified by:
    
    rawIterator in interface ORecordLazyMultiValue
  - convertLinks2Records
```
public void convertLinks2Records()
```
    Description copied from interface: ORecordLazyMultiValue
    
    Browse all the set to convert all the items into records.
    It converts only items that already loaded into memory from storage. To convert records that will be fetched from disk later use OAutoConvertToRecord.setAutoConvertToRecord(boolean)
    
    Specified by:
    
    convertLinks2Records in interface ORecordLazyMultiValue
  - convertRecords2Links
```
public boolean convertRecords2Links()
```
    Description copied from interface: ORecordLazyMultiValue
    
    Browse all the set to convert all the items into links.
    
    Specified by:
    
    convertRecords2Links in interface ORecordLazyMultiValue
    
    Returns:
  - isAutoConvertToRecord
```
public boolean isAutoConvertToRecord()
```
    Specified by:
    
    isAutoConvertToRecord in interface OAutoConvertToRecord
  - setAutoConvertToRecord
```
public void setAutoConvertToRecord(boolean convertToRecord)
```
    Specified by:
    
    setAutoConvertToRecord in interface OAutoConvertToRecord
  - detach
```
public boolean detach()
```
    Description copied from interface: ODetachable
    
    Detaches the object.
    
    Specified by:
    
    detach in interface ODetachable
    
    Returns:
    
    true if the object has been fully detached, otherwise false
  - size
```
public int size()
```
    Specified by:
    
    size in interface OSizeable
  - isEmbedded
```
public boolean isEmbedded()
```
  - isToSerializeEmbedded
```
public boolean isToSerializeEmbedded()
```
  - toStream
```
public int toStream(BytesContainer bytesContainer)
             throws OSerializationException
```
    Throws:
    
    OSerializationException
  - checkAndConvert
```
public void checkAndConvert()
```
  - toStream
```
public OStringBuilderSerializable toStream(StringBuilder output)
                                    throws OSerializationException
```
    Specified by:
    
    toStream in interface OStringBuilderSerializable
    
    Throws:
    
    OSerializationException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - delete
```
public void delete()
```
  - fromStream
```
public OStringBuilderSerializable fromStream(StringBuilder input)
                                      throws OSerializationException
```
    Specified by:
    
    fromStream in interface OStringBuilderSerializable
    
    Throws:
    
    OSerializationException
  - fromStream
```
public void fromStream(byte[] stream)
```
  - fromStream
```
public void fromStream(BytesContainer stream)
```
  - returnOriginalState
```
public Object returnOriginalState(List<OMultiValueChangeEvent<OIdentifiable,OIdentifiable>> multiValueChangeEvents)
```
    Description copied from interface: OTrackedMultiValue
    
    Reverts all operations that were performed on collection and return original collection state.
    
    Specified by:
    
    returnOriginalState in interface OTrackedMultiValue<OIdentifiable,OIdentifiable>
    
    Parameters:
    
    multiValueChangeEvents - List of operations that were performed on collection.
    
    Returns:
    
    Original collection state.
  - getGenericClass
```
public Class<?> getGenericClass()
```
    Specified by:
    
    getGenericClass in interface OTrackedMultiValue<OIdentifiable,OIdentifiable>
  - setOwner
```
public void setOwner(ORecordElement owner)
```
  - getTemporaryId
```
public UUID getTemporaryId()
```
    Temporary id of collection to track changes in remote mode.
    WARNING! Method is for internal usage.
    
    Returns:
    
    UUID
  - setTemporaryId
```
public void setTemporaryId(UUID uuid)
```
  - notifySaved
```
public void notifySaved(OBonsaiCollectionPointer newPointer)
```
    Notify collection that changes has been saved. Converts to non embedded implementation if needed.
    WARNING! Method is for internal usage.
    
    Parameters:
    
    newPointer - new collection pointer
  - getPointer
```
public OBonsaiCollectionPointer getPointer()
```
  - tryMerge
```
public boolean tryMerge(ORidBag otherValue,
                        boolean iMergeSingleItemsOfMultiValueFields)
```
    IMPORTANT! Only for internal usage.
  - init
```
protected void init()
```
  - debugPrint
```
public void debugPrint(PrintStream writer)
                throws IOException
```
    Throws:
    
    IOException
  - getDelegate
```
public ORidBagDelegate getDelegate()
```
  - getChanges
```
public NavigableMap<OIdentifiable,Change> getChanges()
```
  - replace
```
public void replace(OMultiValueChangeEvent<Object,Object> event,
                    Object newValue)
```
    Specified by:
    
    replace in interface OTrackedMultiValue<OIdentifiable,OIdentifiable>
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - enableTracking
```
public void enableTracking(ORecordElement parent)
```
    Specified by:
    
    enableTracking in interface OTrackedMultiValue<OIdentifiable,OIdentifiable>
  - disableTracking
```
public void disableTracking(ORecordElement document)
```
    Specified by:
    
    disableTracking in interface OTrackedMultiValue<OIdentifiable,OIdentifiable>
  - transactionClear
```
public void transactionClear()
```
    Specified by:
    
    transactionClear in interface OTrackedMultiValue<OIdentifiable,OIdentifiable>
  - isModified
```
public boolean isModified()
```
    Specified by:
    
    isModified in interface OTrackedMultiValue<OIdentifiable,OIdentifiable>
  - getTimeLine
```
public OMultiValueChangeTimeLine<Object,Object> getTimeLine()
```
    Specified by:
    
    getTimeLine in interface OTrackedMultiValue<OIdentifiable,OIdentifiable>
  - setDirty
```
public <RET> RET 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
  - getOwner
```
public ORecordElement getOwner()
```
    Specified by:
    
    getOwner in interface ORecordElement
    
    Returns:
    
    Returns record element which contains given one.
  - isTransactionModified
```
public boolean isTransactionModified()
```
    Specified by:
    
    isTransactionModified in interface OTrackedMultiValue<OIdentifiable,OIdentifiable>
  - getTransactionTimeLine
```
public OMultiValueChangeTimeLine<OIdentifiable,OIdentifiable> getTransactionTimeLine()
```
    Specified by:
    
    getTransactionTimeLine in interface OTrackedMultiValue<OIdentifiable,OIdentifiable>
  - setRecordAndField
```
public void setRecordAndField(ORecordId id,
                              String fieldName)
```
  - makeTree
```
public void makeTree()
```
  - makeEmbedded
```
public void makeEmbedded()
```

Class ORidBag

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.orientechnologies.orient.core.db.record.OTrackedMultiValue

Methods inherited from interface java.lang.Iterable

Constructor Detail

ORidBag

ORidBag

ORidBag

ORidBag

ORidBag

ORidBag

Method Detail

fromStream

copy

contains

addAll

add

remove

isEmpty

iterator

rawIterator

convertLinks2Records

convertRecords2Links

isAutoConvertToRecord

setAutoConvertToRecord

detach

size

isEmbedded

isToSerializeEmbedded

toStream

checkAndConvert

toStream

toString

delete

fromStream

fromStream

fromStream

returnOriginalState

getGenericClass

setOwner

getTemporaryId

setTemporaryId

notifySaved

getPointer

tryMerge

init

debugPrint

getDelegate

getChanges

replace

equals

enableTracking

disableTracking

transactionClear

isModified

getTimeLine

setDirty

setDirtyNoChanged

getOwner

isTransactionModified

getTransactionTimeLine

setRecordAndField

makeTree

makeEmbedded