com.mware.ge.store

Class StorableElement

java.lang.Object

com.mware.ge.ElementBase

com.mware.ge.store.StorableElement

All Implemented Interfaces:

Element, ElementId, ElementLocation, GeObject, GeObjectId, HasTimestamp, Serializable, Comparable

Direct Known Subclasses:

StorableEdge, StorableVertex

public abstract class StorableElement
extends ElementBase
implements Serializable, HasTimestamp

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Authorizations	authorizations
static String	CF_EXTENDED_DATA
static String	CF_HIDDEN
static String	CF_PROPERTY
static String	CF_PROPERTY_HIDDEN
static String	CF_PROPERTY_METADATA
static String	CF_PROPERTY_SOFT_DELETE
static String	CF_PROPERTY_VISIBLE
static String	CF_SOFT_DELETE
static String	CQ_HIDDEN
static String	CQ_SOFT_DELETE
static String	DELETE_ROW_COLUMN_FAMILY
static String	DELETE_ROW_COLUMN_QUALIFIER
protected com.google.common.collect.ImmutableSet<String>	extendedDataTableNames
protected FetchHints	fetchHints
protected StorableGraph	graph
static byte[]	HIDDEN_VALUE
static byte[]	HIDDEN_VALUE_DELETED
protected List<HiddenProperty>	hiddenPropertyMarkers
protected Set<Visibility>	hiddenVisibilities
protected String	id
static String	METADATA_COLUMN_FAMILY
static String	METADATA_COLUMN_QUALIFIER
protected PropertyCollection	properties
protected ConcurrentSkipListSet<PropertyDeleteMutation>	propertyDeleteMutations
protected ConcurrentSkipListSet<PropertySoftDeleteMutation>	propertySoftDeleteMutations
static byte[]	SOFT_DELETE_VALUE
protected List<SoftDeletedProperty>	softDeletedProperties
protected long	softDeleteTimestamp
protected Set<StorablePropertyEntry>	storableProperties
protected Set<StorableMetadataEntry>	storablePropertyMetadatas
protected long	timestamp
protected Visibility	visibility
protected List<HiddenProperty>	visiblePropertyMarkers

Fields inherited from interface com.mware.ge.Element

ID_PROPERTY_NAME

Constructor Summary

Constructors

Modifier

Constructor and Description

protected

StorableElement(StorableGraph graph, String id, Visibility visibility, Iterable<Property> properties, Iterable<PropertyDeleteMutation> propertyDeleteMutations, Iterable<PropertySoftDeleteMutation> propertySoftDeleteMutations, Iterable<Visibility> hiddenVisibilities, com.google.common.collect.ImmutableSet<String> extendedDataTableNames, long timestamp, FetchHints fetchHints, Authorizations authorizations)

Method Summary

Modifier and Type	Method and Description
void	addPropertyInternal(Property property)
void	deleteProperty(String key, String name, Visibility visibility, Authorizations authorizations) Permanently deletes a property given it's key and name from the element.
boolean	equals(Object obj)
Authorizations	getAuthorizations() Gets the authorizations used to get this element.
QueryableIterable<ExtendedDataRow>	getExtendedData(String tableName, FetchHints fetchHints) Gets all the rows from an extended data table.
com.google.common.collect.ImmutableSet<String>	getExtendedDataTableNames() Gets the extended data table names.
FetchHints	getFetchHints() Fetch hints used when fetching this element.
StorableGraph	getGraph() Gets the graph that this element belongs to.
Iterable<Visibility>	getHiddenVisibilities() Gets the list of hidden visibilities
Iterable<HistoricalPropertyValue>	getHistoricalPropertyValues(String key, String name, Visibility visibility, Long startTime, Long endTime, Authorizations authorizations) Gets property values from the given range of timestamps in descending timestamp order.
String	getId() get the id of the element
Iterable<Property>	getProperties() an Iterable of all the properties on this element that you have access to based on the authorizations used to retrieve the element.
Iterable<Property>	getProperties(String key, String name) an Iterable of all the properties with the given name and key on this element that you have access to based on the authorizations used to retrieve the element.
Property	getProperty(String key, String name) Gets a property by key and name.
Iterable<PropertyDeleteMutation>	getPropertyDeleteMutations()
Iterable<PropertySoftDeleteMutation>	getPropertySoftDeleteMutations()
Value	getPropertyValue(String name, int index) Gets the nth property value of the named property.
Value	getPropertyValue(String key, String name, int index) Gets the nth property value of the named property.
long	getTimestamp() The timestamp of when this element was updated.
Visibility	getVisibility() the visibility of the element.
int	hashCode()
protected Iterable<Property>	internalGetProperties(String key, String name)
void	markPropertyHidden(Property property, Long timestamp, Visibility visibility, Authorizations authorizations) Marks a property as hidden for a given visibility.
void	markPropertyVisible(Property property, Long timestamp, Visibility visibility, Authorizations authorizations) Marks a property as visible for a given visibility, effectively undoing markPropertyHidden.
abstract <T extends Element> ExistingElementMutation<T>	prepareMutation() Prepares a mutation to allow changing multiple property values at the same time.
protected void	removePropertyInternal(String key, String name, Visibility visibility)
protected <TElement extends Element> void	saveExistingElementMutation(ExistingElementMutation<TElement> mutation, Authorizations authorizations)
void	setVisibility(Visibility visibility)
void	softDeleteProperties(Authorizations authorizations)
void	softDeleteProperty(String key, String name, Visibility visibility, Authorizations authorizations) Soft deletes a property given it's key and name from the element for a given visibility.
String	toString()
protected void	updatePropertiesInternal(Iterable<Property> properties, Iterable<PropertyDeleteMutation> propertyDeleteMutations, Iterable<PropertySoftDeleteMutation> propertySoftDeleteMutations)

Methods inherited from class com.mware.ge.ElementBase

getEdgeLabelProperty, getElementIdProperty, getElementTypeProperty, getIdProperty, getInOrOutVertexIdProperty, getInVertexIdProperty, getOutVertexIdProperty, getProperties, getProperty, getProperty, getReservedProperty, getRowIdProperty, getTableNameProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.mware.ge.Element

addPropertyValue, addPropertyValue, compareTo, deleteProperties, deleteProperty, deleteProperty, getEndTime, getExtendedData, getExtendedData, getExtendedData, getHistoricalPropertyValues, getHistoricalPropertyValues, getHistoricalPropertyValues, isHidden, markPropertyHidden, markPropertyHidden, markPropertyHidden, markPropertyVisible, markPropertyVisible, markPropertyVisible, setProperty, setProperty, softDeleteProperties, softDeleteProperty

Methods inherited from interface com.mware.ge.GeObject

getProperty, getPropertyValue, getPropertyValue, getPropertyValues, getPropertyValues

Methods inherited from interface com.mware.ge.ElementLocation

edge, vertex

Methods inherited from interface com.mware.ge.ElementId

create, edge, getElementType, vertex

Field Detail

CF_PROPERTY

public static final String CF_PROPERTY

See Also:

Constant Field Values

CF_PROPERTY_METADATA

public static final String CF_PROPERTY_METADATA

See Also:

Constant Field Values

CF_PROPERTY_SOFT_DELETE

public static final String CF_PROPERTY_SOFT_DELETE

See Also:

Constant Field Values

CF_EXTENDED_DATA

public static final String CF_EXTENDED_DATA

See Also:

Constant Field Values

CF_PROPERTY_HIDDEN

public static final String CF_PROPERTY_HIDDEN

See Also:

Constant Field Values

CF_PROPERTY_VISIBLE

public static final String CF_PROPERTY_VISIBLE

See Also:

Constant Field Values

CF_HIDDEN

public static final String CF_HIDDEN

See Also:

Constant Field Values

CF_SOFT_DELETE

public static final String CF_SOFT_DELETE

See Also:

Constant Field Values

METADATA_COLUMN_FAMILY

public static final String METADATA_COLUMN_FAMILY

See Also:

Constant Field Values

METADATA_COLUMN_QUALIFIER

public static final String METADATA_COLUMN_QUALIFIER

See Also:

Constant Field Values

DELETE_ROW_COLUMN_FAMILY

public static final String DELETE_ROW_COLUMN_FAMILY

See Also:

Constant Field Values

DELETE_ROW_COLUMN_QUALIFIER

public static final String DELETE_ROW_COLUMN_QUALIFIER

See Also:

Constant Field Values

CQ_SOFT_DELETE

public static final String CQ_SOFT_DELETE

See Also:

Constant Field Values

CQ_HIDDEN

public static final String CQ_HIDDEN

See Also:

Constant Field Values

SOFT_DELETE_VALUE

public static final byte[] SOFT_DELETE_VALUE

HIDDEN_VALUE

public static final byte[] HIDDEN_VALUE

HIDDEN_VALUE_DELETED

public static final byte[] HIDDEN_VALUE_DELETED

graph

protected StorableGraph graph

id

protected String id

visibility

protected Visibility visibility

timestamp

protected long timestamp

softDeleteTimestamp

protected long softDeleteTimestamp

fetchHints

protected FetchHints fetchHints

hiddenVisibilities

protected Set<Visibility> hiddenVisibilities

properties

protected PropertyCollection properties

extendedDataTableNames

protected com.google.common.collect.ImmutableSet<String> extendedDataTableNames

propertyDeleteMutations

protected ConcurrentSkipListSet<PropertyDeleteMutation> propertyDeleteMutations

propertySoftDeleteMutations

protected ConcurrentSkipListSet<PropertySoftDeleteMutation> propertySoftDeleteMutations

authorizations

protected Authorizations authorizations

softDeletedProperties

protected List<SoftDeletedProperty> softDeletedProperties

hiddenPropertyMarkers

protected List<HiddenProperty> hiddenPropertyMarkers

visiblePropertyMarkers

protected List<HiddenProperty> visiblePropertyMarkers

storableProperties

protected Set<StorablePropertyEntry> storableProperties

storablePropertyMetadatas

protected Set<StorableMetadataEntry> storablePropertyMetadatas

Constructor Detail

StorableElement

protected StorableElement(StorableGraph graph,
                          String id,
                          Visibility visibility,
                          Iterable<Property> properties,
                          Iterable<PropertyDeleteMutation> propertyDeleteMutations,
                          Iterable<PropertySoftDeleteMutation> propertySoftDeleteMutations,
                          Iterable<Visibility> hiddenVisibilities,
                          com.google.common.collect.ImmutableSet<String> extendedDataTableNames,
                          long timestamp,
                          FetchHints fetchHints,
                          Authorizations authorizations)

Method Detail

deleteProperty

public void deleteProperty(String key,
                           String name,
                           Visibility visibility,
                           Authorizations authorizations)

Description copied from interface: Element

Permanently deletes a property given it's key and name from the element. Only properties which you have access to can be deleted using this method.

Specified by:

deleteProperty in interface Element

Parameters:

key - The property key.

name - The property name.

visibility - The property visibility.

softDeleteProperty

public void softDeleteProperty(String key,
                               String name,
                               Visibility visibility,
                               Authorizations authorizations)

Description copied from interface: Element

Soft deletes a property given it's key and name from the element for a given visibility. Only properties which you have access to can be soft deleted using this method.

Specified by:

softDeleteProperty in interface Element

Parameters:

key - The property key.

name - The property name.

visibility - The visibility string of the property to soft delete.

softDeleteProperties

public void softDeleteProperties(Authorizations authorizations)

markPropertyHidden

public void markPropertyHidden(Property property,
                               Long timestamp,
                               Visibility visibility,
                               Authorizations authorizations)

Description copied from interface: Element

Marks a property as hidden for a given visibility.

Specified by:

markPropertyHidden in interface Element

Parameters:

property - The property.

timestamp - The timestamp.

visibility - The visibility string under which this property is hidden. This visibility can be a superset of the property visibility to mark it as hidden for only a subset of authorizations.

authorizations - The authorizations used.

markPropertyVisible

public void markPropertyVisible(Property property,
                                Long timestamp,
                                Visibility visibility,
                                Authorizations authorizations)

Description copied from interface: Element

Marks a property as visible for a given visibility, effectively undoing markPropertyHidden.

Specified by:

markPropertyVisible in interface Element

Parameters:

property - The property.

timestamp - The timestamp.

visibility - The visibility string under which this property is now visible.

authorizations - The authorizations used.

saveExistingElementMutation

protected <TElement extends Element> void saveExistingElementMutation(ExistingElementMutation<TElement> mutation,
                                                                      Authorizations authorizations)

getHistoricalPropertyValues

public Iterable<HistoricalPropertyValue> getHistoricalPropertyValues(String key,
                                                                     String name,
                                                                     Visibility visibility,
                                                                     Long startTime,
                                                                     Long endTime,
                                                                     Authorizations authorizations)

Description copied from interface: Element

Gets property values from the given range of timestamps in descending timestamp order.

Specified by:

getHistoricalPropertyValues in interface Element

Parameters:

key - the key of the property.

name - the name of the property.

visibility - The visibility of the property to get.

prepareMutation

public abstract <T extends Element> ExistingElementMutation<T> prepareMutation()

Description copied from interface: Element

Prepares a mutation to allow changing multiple property values at the same time. This method is similar to Graph#prepareVertex(Visibility, Authorizations) in that it allows multiple properties to be changed and saved in a single mutation.

Specified by:

prepareMutation in interface Element

Returns:

The mutation builder.

getExtendedData

public QueryableIterable<ExtendedDataRow> getExtendedData(String tableName,
                                                          FetchHints fetchHints)

Description copied from interface: Element

Gets all the rows from an extended data table.

Specified by:

getExtendedData in interface Element

Parameters:

tableName - The name of the table to get rows from.

Returns:

Iterable of all the rows.

getProperty

public Property getProperty(String key,
                            String name)

Description copied from interface: GeObject

Gets a property by key and name.

Specified by:

getProperty in interface GeObject

Parameters:

key - the key of the property.

name - the name of the property.

Returns:

The property if found. null, if not found.

getPropertyValue

public Value getPropertyValue(String name,
                              int index)

Description copied from interface: GeObject

Gets the nth property value of the named property. If the named property has multiple values this method provides an easy way to get the value by index.

This method is a convenience method and calls Element#getPropertyValues(java.lang.String) and iterates over that list until the nth value.

This method assumes the property values are retrieved in a deterministic order.

Specified by:

getPropertyValue in interface GeObject

Parameters:

name - The name of the property to retrieve.

index - The zero based index into the values.

Returns:

The value of the property. null, if the property doesn't exist or doesn't have that many values.

getPropertyValue

public Value getPropertyValue(String key,
                              String name,
                              int index)

Description copied from interface: GeObject

Gets the nth property value of the named property. If the named property has multiple values this method provides an easy way to get the value by index.

This method is a convenience method and calls Element#getPropertyValues(java.lang.String, java.lang.String) and iterates over that list until the nth value.

This method assumes the property values are retrieved in a deterministic order.

Specified by:

getPropertyValue in interface GeObject

Parameters:

key - The property key

name - The name of the property to retrieve.

index - The zero based index into the values.

Returns:

The value of the property. null, if the property doesn't exist or doesn't have that many values.

getId

public String getId()

Description copied from interface: ElementId

get the id of the element

Specified by:

getId in interface ElementId

Specified by:

getId in interface GeObject

Returns:

element id

getVisibility

public Visibility getVisibility()

Description copied from interface: Element

the visibility of the element.

Specified by:

getVisibility in interface Element

Specified by:

getVisibility in interface ElementLocation

getTimestamp

public long getTimestamp()

Description copied from interface: Element

The timestamp of when this element was updated.

Specified by:

getTimestamp in interface Element

Specified by:

getTimestamp in interface HasTimestamp

setVisibility

public void setVisibility(Visibility visibility)

getProperties

public Iterable<Property> getProperties()

Description copied from interface: GeObject

an Iterable of all the properties on this element that you have access to based on the authorizations used to retrieve the element.

Specified by:

getProperties in interface GeObject

getPropertyDeleteMutations

public Iterable<PropertyDeleteMutation> getPropertyDeleteMutations()

getPropertySoftDeleteMutations

public Iterable<PropertySoftDeleteMutation> getPropertySoftDeleteMutations()

getProperties

public Iterable<Property> getProperties(String key,
                                        String name)

Description copied from interface: GeObject

an Iterable of all the properties with the given name and key on this element that you have access to based on the authorizations used to retrieve the element.

Specified by:

getProperties in interface GeObject

Overrides:

getProperties in class ElementBase

Parameters:

key - The property key

name - The name of the property to retrieve

getGraph

public StorableGraph getGraph()

Description copied from interface: Element

Gets the graph that this element belongs to.

Specified by:

getGraph in interface Element

updatePropertiesInternal

protected void updatePropertiesInternal(Iterable<Property> properties,
                                        Iterable<PropertyDeleteMutation> propertyDeleteMutations,
                                        Iterable<PropertySoftDeleteMutation> propertySoftDeleteMutations)

removePropertyInternal

protected void removePropertyInternal(String key,
                                      String name,
                                      Visibility visibility)

addPropertyInternal

public void addPropertyInternal(Property property)

hashCode

public int hashCode()

Overrides:

hashCode in class ElementBase

toString

public String toString()

Overrides:

toString in class ElementBase

equals

public boolean equals(Object obj)

Overrides:

equals in class ElementBase

getAuthorizations

public Authorizations getAuthorizations()

Description copied from interface: Element

Gets the authorizations used to get this element.

Specified by:

getAuthorizations in interface Element

getHiddenVisibilities

public Iterable<Visibility> getHiddenVisibilities()

Description copied from interface: Element

Gets the list of hidden visibilities

Specified by:

getHiddenVisibilities in interface Element

getExtendedDataTableNames

public com.google.common.collect.ImmutableSet<String> getExtendedDataTableNames()

Description copied from interface: Element

Gets the extended data table names.

Specified by:

getExtendedDataTableNames in interface Element

getFetchHints

public FetchHints getFetchHints()

Description copied from interface: Element

Fetch hints used when fetching this element.

Specified by:

getFetchHints in interface Element

internalGetProperties

protected Iterable<Property> internalGetProperties(String key,
                                                   String name)

Overrides:

internalGetProperties in class ElementBase