oracle.pgx.api

Class Property<ID,K extends PgxEntity<ID>,V>

java.lang.Object

oracle.pgx.api.internal.ApiObject

oracle.pgx.api.Destroyable

oracle.pgx.api.PgxManagedObject

oracle.pgx.api.Property<ID,K,V>

Type Parameters:

ID - the identifier type of this property's entity (node or edge IdType)

K - the type of this property's entity (node or edge, PgxEntity)

V - the type of this property (see PropertyType)

All Implemented Interfaces:

java.lang.AutoCloseable, java.lang.Cloneable

Direct Known Subclasses:

EdgeProperty, VertexProperty

public abstract class Property<ID,K extends PgxEntity<ID>,V>
extends PgxManagedObject
implements java.lang.Cloneable

A property of a PgxGraph.

Method Summary

Modifier and Type	Method and Description
PgxFuture<java.lang.Void>	destroyAsync() Requests destruction of this object.
boolean	equals(java.lang.Object obj)
void	fill(V value) Blocking version of fillAsync(Object).
PgxFuture<java.lang.Void>	fillAsync(V value) Fill this property with a given value.
V	get(ID id) Blocking version of getAsync(Object).
V	get(K key) Blocking version of getAsync(PgxEntity).
PgxFuture<V>	getAsync(ID id) Gets the property value.
PgxFuture<V>	getAsync(K key) Gets the property value.
EntryIterable<ID,K,V>	getBottomKValues(int k) Blocking version of getBottomKValuesAsync(int).
PgxFuture<EntryIterable<ID,K,V>>	getBottomKValuesAsync(int k) Gets the bottom k vertex/edge value pairs according to their value.
int	getDimension() Gets the dimension.
EntityType	getEntityType() Gets the entity type.
PgxGraph	getGraph() Gets the graph.
java.lang.String	getName() Gets the name.
oracle.pgx.common.PgxId	getPropertyId() Returns an internal identifier for this property Only meant for internal usage.
EntryIterable<ID,K,V>	getTopKValues(int k) Blocking version of getTopKValuesAsync(int).
PgxFuture<EntryIterable<ID,K,V>>	getTopKValuesAsync(int k) Gets the top k vertex/edge value pairs according to their value.
PropertyType	getType() Gets the PropertyType.
EntryIterable<ID,K,V>	getValues() Blocking version of getValuesAsync().
PgxFuture<EntryIterable<ID,K,V>>	getValuesAsync() Gets the values.
int	hashCode()
boolean	isPublished() Blocking version of isPublished().
PgxFuture<java.lang.Boolean>	isPublishedAsync() Checks if this property is published.
boolean	isTransient() Checks the transient flag of this property.
boolean	isVectorProperty() Checks if this property holds vectors or scalars.
void	publish() Blocking version of publish().
PgxFuture<java.lang.Void>	publishAsync() Publishes the property into a shared graph so It can be shared between sessions.
void	rename(java.lang.String newPropertyName) Blocking version of renameAsync(String).
PgxFuture<java.lang.Void>	renameAsync(java.lang.String newPropertyName) Renames this property.
void	set(K key, V value) Blocking version of setAsync(PgxEntity, Object).
PgxFuture<java.lang.Void>	setAsync(K key, V value) Sets a property value.
void	setValues(java.util.Map<K,V> values) Blocking version of setValuesAsync(Map).
void	setValues(java.util.Map<K,V> values, V defaultValue) Blocking version of setValuesAsync(Map, Object).
PgxFuture<java.lang.Void>	setValuesAsync(java.util.Map<K,V> values) Sets multiple property values.
PgxFuture<java.lang.Void>	setValuesAsync(java.util.Map<K,V> values, V defaultValue) Sets multiple property values.
long	size() Blocking version of sizeAsync().
PgxFuture<java.lang.Long>	sizeAsync() Gets the size/length of this property.
java.lang.String	toString()
static <V> V	wrap(V value, PropertyType type, PgxGraph graph)

Methods inherited from class oracle.pgx.api.Destroyable

close, destroy

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

destroyAsync

public PgxFuture<java.lang.Void> destroyAsync()

Description copied from class: Destroyable

Requests destruction of this object. After this method returns, the behavior of any method of this class becomes undefined.

Specified by:

destroyAsync in class Destroyable

Returns:

a future which will be completed once the destruction request finishes.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class PgxManagedObject

fill

public void fill(V value)
          throws java.util.concurrent.ExecutionException,
                 java.lang.InterruptedException

Blocking version of fillAsync(Object). Calls fillAsync(Object) and waits for the returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

fillAsync

public PgxFuture<java.lang.Void> fillAsync(V value)

Fill this property with a given value.

Parameters:

value - the value

get

public V get(ID id)

Blocking version of getAsync(Object). Calls getAsync(Object) and waits for the returned PgxFuture to complete.

get

public V get(K key)

Blocking version of getAsync(PgxEntity). Calls getAsync(PgxEntity) and waits for the returned PgxFuture to complete.

getAsync

public PgxFuture<V> getAsync(ID id)

Gets the property value.

Parameters:

id - the id of the property

Returns:

property value

getAsync

public PgxFuture<V> getAsync(K key)

Gets the property value.

Parameters:

key - the key of the property

Returns:

property value

getBottomKValues

public EntryIterable<ID,K,V> getBottomKValues(int k)

Blocking version of getBottomKValuesAsync(int). Calls getBottomKValuesAsync(int) and waits for returned PgxFuture to complete.

getBottomKValuesAsync

public PgxFuture<EntryIterable<ID,K,V>> getBottomKValuesAsync(int k)

Gets the bottom k vertex/edge value pairs according to their value.

Parameters:

k - how many bottom values to retrieve, must be in the range between 0 and number of nodes/edges (inclusive)

Returns:

iterable over the values

getDimension

public int getDimension()

Gets the dimension.

Returns:

the dimension. If isVectorProperty() is false, the dimension will be 0.

getEntityType

public EntityType getEntityType()

Gets the entity type.

Returns:

the entity type of this property

getGraph

public PgxGraph getGraph()

Gets the graph.

Returns:

the graph this property belongs to

getName

public java.lang.String getName()

Gets the name.

Specified by:

getName in class PgxManagedObject

Returns:

the name of this property

getPropertyId

public final oracle.pgx.common.PgxId getPropertyId()

Returns an internal identifier for this property Only meant for internal usage.

Returns:

the internal identifier of this property

Since:

21.1

getTopKValues

public EntryIterable<ID,K,V> getTopKValues(int k)

Blocking version of getTopKValuesAsync(int). Calls getTopKValuesAsync(int) and waits for the returned PgxFuture to complete.

getTopKValuesAsync

public PgxFuture<EntryIterable<ID,K,V>> getTopKValuesAsync(int k)

Gets the top k vertex/edge value pairs according to their value.

Parameters:

k - how many top values to retrieve, must be in the range between 0 and number of nodes/edges (inclusive)

Returns:

iterable over the values

getType

public PropertyType getType()

Gets the PropertyType.

Returns:

the propertytype

getValues

public EntryIterable<ID,K,V> getValues()

Blocking version of getValuesAsync(). Calls getValuesAsync() and waits for the returned PgxFuture to complete.

getValuesAsync

public PgxFuture<EntryIterable<ID,K,V>> getValuesAsync()

Gets the values.

Returns:

an iterable of the values

hashCode

public int hashCode()

Overrides:

hashCode in class PgxManagedObject

isPublished

public boolean isPublished()

Blocking version of isPublished(). Calls isPublished() and waits for returned PgxFuture to complete.

isPublishedAsync

public PgxFuture<java.lang.Boolean> isPublishedAsync()

Checks if this property is published.

Returns:

true if this property is published, false otherwise.

isTransient

public boolean isTransient()

Checks the transient flag of this property.

Returns:

true if this property is transient (session-bound, private), false otherwise.

isVectorProperty

public boolean isVectorProperty()

Checks if this property holds vectors or scalars.

Returns:

true if this is a vector property, false otherwise.

publish

public void publish()

Blocking version of publish(). Calls publish() and waits for returned PgxFuture to complete.

publishAsync

public PgxFuture<java.lang.Void> publishAsync()

Publishes the property into a shared graph so It can be shared between sessions.

rename

public void rename(java.lang.String newPropertyName)

Blocking version of renameAsync(String). Calls renameAsync(String) and waits for the returned PgxFuture to complete.

renameAsync

public PgxFuture<java.lang.Void> renameAsync(java.lang.String newPropertyName)

Renames this property.

Parameters:

newPropertyName - the new name.

set

public void set(K key,
                V value)

Blocking version of setAsync(PgxEntity, Object). Calls setAsync(PgxEntity, Object) and waits for the returned PgxFuture to complete.

setAsync

public PgxFuture<java.lang.Void> setAsync(K key,
                                          V value)

Sets a property value.

Parameters:

key - the key (vertex/edge) whose property to set.

value - the property value.

setValues

public void setValues(java.util.Map<K,V> values)

Blocking version of setValuesAsync(Map). Calls setValuesAsync(Map) and waits for the returned PgxFuture to complete.

setValues

public void setValues(java.util.Map<K,V> values,
                      V defaultValue)

Blocking version of setValuesAsync(Map, Object). Calls setValuesAsync(Map, Object) and waits for the returned PgxFuture to complete.

setValuesAsync

public PgxFuture<java.lang.Void> setValuesAsync(java.util.Map<K,V> values)

Sets multiple property values.

Parameters:

values - the key/value mapping to set.

setValuesAsync

public PgxFuture<java.lang.Void> setValuesAsync(java.util.Map<K,V> values,
                                                V defaultValue)

Sets multiple property values.

Parameters:

values - the values to set

defaultValue - default value if one of the values fails to be put

size

public long size()

Blocking version of sizeAsync(). Calls sizeAsync() and waits for the returned PgxFuture to complete.

sizeAsync

public PgxFuture<java.lang.Long> sizeAsync()

Gets the size/length of this property.

Returns:

the size of the property.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

wrap

public static <V> V wrap(V value,
                         PropertyType type,
                         PgxGraph graph)