com.mware.ge.inmemory

Class InMemoryElement<TElement extends InMemoryElement>

java.lang.Object

com.mware.ge.ElementBase

com.mware.ge.inmemory.InMemoryElement<TElement>

All Implemented Interfaces:

Element, ElementId, ElementLocation, GeObject, GeObjectId, Comparable

Direct Known Subclasses:

InMemoryEdge, InMemoryVertex

public abstract class InMemoryElement<TElement extends InMemoryElement>
extends ElementBase

Field Summary

Fields inherited from interface com.mware.ge.Element

ID_PROPERTY_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InMemoryElement(InMemoryGraph graph, String id, InMemoryTableElement<TElement> inMemoryTableElement, FetchHints fetchHints, Long endTime, Authorizations authorizations)

Method Summary

Modifier and Type	Method and Description
void	addPropertyValue(String key, String name, Value value, Metadata metadata, Visibility visibility, Long timestamp, boolean indexAfterAdd, Authorizations authorizations)
boolean	canRead(Authorizations authorizations)
void	deleteProperty(String key, String name, Visibility visibility, Authorizations authorizations) Permanently deletes a property given it's key and name from the element.
protected void	extendedData(ExtendedDataMutation extendedData, Authorizations authorizations)
Authorizations	getAuthorizations() Gets the authorizations used to get this element.
Long	getEndTime()
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.
InMemoryGraph	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
protected InMemoryTableElement<TElement>	getInMemoryTableElement()
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.
Value	getPropertyValue(String name) Convenience method to retrieve the first value of the property with the given name.
Value	getPropertyValue(String key, String name) Convenience method to retrieve the first value of the property with the given name.
long	getTimestamp() The timestamp of when this element was updated.
Visibility	getVisibility() the visibility of the element.
boolean	isHidden(Authorizations authorizations) Given the supplied authorizations is this element hidden?
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.
void	markPropertyVisible(String key, String name, Visibility propertyVisibility, 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 <T extends Element> void	saveExistingElementMutation(ExistingElementMutationImpl<T> mutation, IndexHint indexHint, Authorizations authorizations)
protected void	setInMemoryTableElement(InMemoryTableElement<TElement> inMemoryTableElement)
protected void	softDeleteProperty(String key, String name, Long timestamp, Visibility visibility, IndexHint indexHint, 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.
protected void	updatePropertiesInternal(Iterable<Property> properties, Iterable<PropertyDeleteMutation> propertyDeleteMutations, Iterable<PropertySoftDeleteMutation> propertySoftDeleteMutations, Iterable<ExtendedDataMutation> extendedDatas, Iterable<ExtendedDataDeleteMutation> extendedDataDeletes, IndexHint indexHint)

Methods inherited from class com.mware.ge.ElementBase

equals, getEdgeLabelProperty, getElementIdProperty, getElementTypeProperty, getIdProperty, getInOrOutVertexIdProperty, getInVertexIdProperty, getOutVertexIdProperty, getProperties, getProperties, getProperty, getProperty, getReservedProperty, getRowIdProperty, getTableNameProperty, hashCode, internalGetProperties, toString

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, getExtendedData, getExtendedData, getExtendedData, getHistoricalPropertyValues, getHistoricalPropertyValues, getHistoricalPropertyValues, markPropertyHidden, markPropertyHidden, markPropertyHidden, markPropertyVisible, markPropertyVisible, setProperty, setProperty, softDeleteProperties, softDeleteProperty

Methods inherited from interface com.mware.ge.GeObject

getProperty, 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

Constructor Detail

InMemoryElement

protected InMemoryElement(InMemoryGraph graph,
                          String id,
                          InMemoryTableElement<TElement> inMemoryTableElement,
                          FetchHints fetchHints,
                          Long endTime,
                          Authorizations authorizations)

Method Detail

getId

public String getId()

Description copied from interface: ElementId

get the id of the element

Returns:

element id

getVisibility

public Visibility getVisibility()

Description copied from interface: Element

the visibility of the element.

getTimestamp

public long getTimestamp()

Description copied from interface: Element

The timestamp of when this element was updated.

getEndTime

public Long getEndTime()

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.

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.

Parameters:

key - The property key.

name - The property name.

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

softDeleteProperty

protected void softDeleteProperty(String key,
                                  String name,
                                  Long timestamp,
                                  Visibility visibility,
                                  IndexHint indexHint,
                                  Authorizations authorizations)

extendedData

protected void extendedData(ExtendedDataMutation extendedData,
                            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.

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.

Parameters:

property - The property.

timestamp - The timestamp.

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

authorizations - The authorizations used.

getPropertyValue

public Value getPropertyValue(String name)

Description copied from interface: GeObject

Convenience method to retrieve the first value of the property with the given name. This method calls Element#getPropertyValue(java.lang.String, int) with an index of 0.

This method makes no attempt to verify that one and only one value exists given the name.

Parameters:

name - The name of the property to retrieve

Returns:

The value of the property. null, if the property was not found.

getPropertyValue

public Value getPropertyValue(String key,
                              String name)

Description copied from interface: GeObject

Convenience method to retrieve the first value of the property with the given name. This method calls Element#getPropertyValue(java.lang.String, java.lang.String, int) with an index of 0.

This method makes no attempt to verify that one and only one value exists given the name.

Parameters:

key - The key of the property

name - The name of the property to retrieve

Returns:

The value of the property. null, if the property was not found.

addPropertyValue

public void addPropertyValue(String key,
                             String name,
                             Value value,
                             Metadata metadata,
                             Visibility visibility,
                             Long timestamp,
                             boolean indexAfterAdd,
                             Authorizations authorizations)

markPropertyVisible

public void markPropertyVisible(String key,
                                String name,
                                Visibility propertyVisibility,
                                Long timestamp,
                                Visibility visibility,
                                Authorizations authorizations)

Description copied from interface: Element

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

Parameters:

key - The key of the property.

name - The name of the property.

propertyVisibility - The visibility of the property.

timestamp - The timestamp.

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

authorizations - The authorizations used.

isHidden

public boolean isHidden(Authorizations authorizations)

Description copied from interface: Element

Given the supplied authorizations is this element hidden?

Parameters:

authorizations - the authorizations to check against.

Returns:

true, if it would be hidden from those authorizations.

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.

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.

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.

Returns:

The mutation builder.

getAuthorizations

public Authorizations getAuthorizations()

Description copied from interface: Element

Gets the authorizations used to get this element.

getGraph

public InMemoryGraph getGraph()

Description copied from interface: Element

Gets the graph that this element belongs to.

updatePropertiesInternal

protected void updatePropertiesInternal(Iterable<Property> properties,
                                        Iterable<PropertyDeleteMutation> propertyDeleteMutations,
                                        Iterable<PropertySoftDeleteMutation> propertySoftDeleteMutations,
                                        Iterable<ExtendedDataMutation> extendedDatas,
                                        Iterable<ExtendedDataDeleteMutation> extendedDataDeletes,
                                        IndexHint indexHint)

saveExistingElementMutation

protected <T extends Element> void saveExistingElementMutation(ExistingElementMutationImpl<T> mutation,
                                                               IndexHint indexHint,
                                                               Authorizations authorizations)

canRead

public boolean canRead(Authorizations authorizations)

getHiddenVisibilities

public Iterable<Visibility> getHiddenVisibilities()

Description copied from interface: Element

Gets the list of hidden visibilities

getFetchHints

public FetchHints getFetchHints()

Description copied from interface: Element

Fetch hints used when fetching this element.

getInMemoryTableElement

protected InMemoryTableElement<TElement> getInMemoryTableElement()

setInMemoryTableElement

protected void setInMemoryTableElement(InMemoryTableElement<TElement> inMemoryTableElement)

getExtendedDataTableNames

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

Description copied from interface: Element

Gets the extended data table names.

getExtendedData

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

Description copied from interface: Element

Gets all the rows from an extended data table.

Parameters:

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

Returns:

Iterable of all the rows.