oracle.pg.common

Class OracleElementBase

java.lang.Object

oracle.pg.common.OracleElementBase

All Implemented Interfaces:

OracleElement

Direct Known Subclasses:

OracleEdgeBase, OracleVertexBase

public abstract class OracleElementBase
extends java.lang.Object
implements OracleElement

This class implements the Blueprints Element interface on top of a supported backend database.

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.pg.common.OracleElement

OracleElement.FLAG

Constructor Summary

Constructors

Constructor and Description
OracleElementBase()
OracleElementBase(OraclePropertyGraphBase opg, java.lang.Long id)

Method Summary

Modifier and Type	Method and Description
void	clearAddedKeys() Clears the hash set of the added keys
void	clearDeletedKeys() Clears the hash set of the deleted keys
abstract void	forceRefresh() Re-read the attributes about this graph element from the database.
java.util.Set<java.lang.String>	getAddedKeys() Gets a hash set of the added keys
java.lang.String	getAttributes() Returns a String of all the Key, Value Pairs.
java.util.Set<java.lang.String>	getDeletedKeys() Gets a hash set of the deleted keys
java.util.List<java.lang.Object>	getDeletedProperties(java.lang.String key) Gets the value for the specified deleted keys
OracleElement.FLAG	getFlag()
OraclePropertyGraphBase	graph() Gets the property graph instance associated to this object.
java.lang.Object	id() Returns an identifier of this element that is unique to its inheriting class.
boolean	isPartial() Returns TRUE if this object is partially constructured.
java.util.Set<java.lang.String>	keys() Return all the keys associated with the element.
abstract <V> OraclePropertyBase<V>	property(java.lang.String key)
void	property(java.lang.String key, java.lang.Object value, boolean skipQueue) Assign a key/value property to the element.
void	property(java.lang.String key, java.lang.Object value, boolean skipQueue, boolean skipLucene) Assign a key/value property to the element.
void	propertyCommon(java.lang.String key, java.lang.Object value, boolean skipQueue) Assign a key/value property to the element.
java.lang.Object	propertyValue(java.lang.String key) Return the value associated with the provided key.
void	refresh() Re-read the attributes about this graph element from the database if this element is only partially constructed.
java.lang.Object	removeProperty(java.lang.String key) Un-assigns a key/value property from the element.
void	setCreatedWithOptFlag(boolean bFlag) Set the flag denoting if the element is created with optimization flag
void	setFlag(OracleElement.FLAG f)
void	setGraph(OraclePropertyGraphBase opg) Sets the property graph instance associated to this element
void	setPartial(boolean partial) Set a flag to denote if this graph element is only partially constructed.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.pg.common.OracleElement

label, properties, property, remove

Constructor Detail

OracleElementBase

public OracleElementBase()

OracleElementBase

public OracleElementBase(OraclePropertyGraphBase opg,
                         java.lang.Long id)

Method Detail

clearAddedKeys

public void clearAddedKeys()

Clears the hash set of the added keys

clearDeletedKeys

public void clearDeletedKeys()

Clears the hash set of the deleted keys

forceRefresh

public abstract void forceRefresh()
                           throws java.lang.Exception

Re-read the attributes about this graph element from the database.

Throws:

java.lang.Exception

getAddedKeys

public java.util.Set<java.lang.String> getAddedKeys()

Gets a hash set of the added keys

getAttributes

public final java.lang.String getAttributes()

Returns a String of all the Key, Value Pairs.

getDeletedKeys

public java.util.Set<java.lang.String> getDeletedKeys()

Gets a hash set of the deleted keys

getDeletedProperties

public java.util.List<java.lang.Object> getDeletedProperties(java.lang.String key)

Gets the value for the specified deleted keys

getFlag

public final OracleElement.FLAG getFlag()

graph

public OraclePropertyGraphBase graph()

Description copied from interface: OracleElement

Gets the property graph instance associated to this object. All the changes done to this object will be committed once the commit operation is executed for this property graph.

Specified by:

graph in interface OracleElement

Returns:

a OraclePropertyGraphBase

id

public final java.lang.Object id()

Description copied from interface: OracleElement

Returns an identifier of this element that is unique to its inheriting class.

Specified by:

id in interface OracleElement

isPartial

public boolean isPartial()

Returns TRUE if this object is partially constructured. For example, a vertex with just an ID but not the K/V pairs. Or an edge with just an ID but not the in/out vertices or edge label.

keys

public java.util.Set<java.lang.String> keys()

Return all the keys associated with the element.

property

public abstract <V> OraclePropertyBase<V> property(java.lang.String key)

property

public final void property(java.lang.String key,
                           java.lang.Object value,
                           boolean skipQueue)

Assign a key/value property to the element.

Parameters:

key - key of the attribute (K/V)

value - value of the attribute (K/V)

skipQueue - when true, then this K/V pair change will not cause this Element to be put in the update queue.

property

public final void property(java.lang.String key,
                           java.lang.Object value,
                           boolean skipQueue,
                           boolean skipLucene)

Assign a key/value property to the element.

Parameters:

key - key of the attribute (K/V)

value - value of the attribute (K/V)

skipQueue - when true, then this K/V pair change will not cause this Element to be put in the update queue.

skipLucene - when true, then this K/V pair will not be indexed

propertyCommon

public final void propertyCommon(java.lang.String key,
                                 java.lang.Object value,
                                 boolean skipQueue)

Assign a key/value property to the element.

Parameters:

key - key of an attribute (K/V pair)

value - value of an attribute (K/V pair)

skipQueue - when true, then this K/V pair change will not cause this Element to be put in the update queye.

propertyValue

public java.lang.Object propertyValue(java.lang.String key)

Return the value associated with the provided key.

refresh

public void refresh()

Re-read the attributes about this graph element from the database if this element is only partially constructed.

removeProperty

public final java.lang.Object removeProperty(java.lang.String key)

Un-assigns a key/value property from the element.

setCreatedWithOptFlag

public void setCreatedWithOptFlag(boolean bFlag)

Set the flag denoting if the element is created with optimization flag

setFlag

public final void setFlag(OracleElement.FLAG f)

setGraph

public final void setGraph(OraclePropertyGraphBase opg)

Sets the property graph instance associated to this element

Parameters:

opg - a OraclePropertyGraph object

setPartial

public void setPartial(boolean partial)

Set a flag to denote if this graph element is only partially constructed. For example, a vertex with just an ID but not the K/V pairs. Or an edge with just an ID but not the in/out vertices or edge label.

Parameters:

partial - true if this graph element is only partially constructed.