org.vertexium

Interface Element

All Superinterfaces:

Comparable, VertexiumObject

All Known Subinterfaces:

Edge, Vertex

All Known Implementing Classes:

EdgeInfoEdge, ElementBase

public interface Element
extends VertexiumObject

An element on the graph. This can be either a vertex or edge.

Elements also contain properties. These properties are unique given their key, name, and visibility. For example a property with key "key1" and name "age" could have to values, one with visibility "a" and one with visibility "b".

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID_PROPERTY_NAME Meta property name used for operations such as sorting

Method Summary

Modifier and Type	Method and Description
default void	addPropertyValue(String key, String name, Object value, Metadata metadata, Visibility visibility, Authorizations authorizations) Adds or updates a property.
default void	addPropertyValue(String key, String name, Object value, Visibility visibility, Authorizations authorizations) Adds or updates a property.
default int	compareTo(Object o)
default void	deleteProperties(String name, Authorizations authorizations) Permanently deletes all properties with the given name that you have access to.
default void	deleteProperty(Property property, Authorizations authorizations) Permanently deletes a property from the element.
default void	deleteProperty(String key, String name, Authorizations authorizations) Permanently deletes a property given it's key and name from the element.
void	deleteProperty(String key, String name, Visibility visibility, Authorizations authorizations) Permanently deletes a property given it's key and name from the element.
Authorizations	getAuthorizations() Gets the authorizations used to get this element.
QueryableIterable<ExtendedDataRow>	getExtendedData(String tableName) Gets all the rows from an extended data table.
com.google.common.collect.ImmutableSet<String>	getExtendedDataTableNames() Gets the list of extended data table names.
FetchHints	getFetchHints() Fetch hints used when fetching this element.
Graph	getGraph() Gets the graph that this element belongs to.
Iterable<Visibility>	getHiddenVisibilities() Gets the list of hidden visibilities
default Iterable<HistoricalPropertyValue>	getHistoricalPropertyValues(Authorizations authorizations) Gets all property values from all timestamps in descending timestamp order.
default Iterable<HistoricalPropertyValue>	getHistoricalPropertyValues(Long startTime, Long endTime, Authorizations authorizations) Gets all property values from the given range of timestamps in descending timestamp order.
default Iterable<HistoricalPropertyValue>	getHistoricalPropertyValues(String key, String name, Visibility visibility, Authorizations authorizations) Gets property values from all timestamps in descending timestamp order.
default 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() id of the element.
long	getTimestamp() The timestamp of when this element was updated.
Visibility	getVisibility() the visibility of the element.
default 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.
default void	markPropertyHidden(Property property, Visibility visibility, Authorizations authorizations) Marks a property as hidden for a given visibility.
default void	markPropertyHidden(String key, String name, Visibility propertyVisibility, Long timestamp, Visibility visibility, Authorizations authorizations) Marks a property as hidden for a given visibility.
default void	markPropertyHidden(String key, String name, Visibility propertyVisibility, 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.
default void	markPropertyVisible(Property property, Visibility visibility, Authorizations authorizations) Marks a property as visible for a given visibility, effectively undoing markPropertyHidden.
default 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.
default void	markPropertyVisible(String key, String name, Visibility propertyVisibility, Visibility visibility, Authorizations authorizations) Marks a property as visible for a given visibility, effectively undoing markPropertyHidden.
<T extends Element> ExistingElementMutation<T>	prepareMutation() Prepares a mutation to allow changing multiple property values at the same time.
default void	setProperty(String name, Object value, Metadata metadata, Visibility visibility, Authorizations authorizations) Sets or updates a property value.
default void	setProperty(String name, Object value, Visibility visibility, Authorizations authorizations) Sets or updates a property value.
default void	softDeleteProperties(String name, Authorizations authorizations) Soft deletes all properties with the given name that you have access to.
default void	softDeleteProperty(String key, String name, Authorizations authorizations) Soft deletes a property given it's key and name from the element.
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.

Methods inherited from interface org.vertexium.VertexiumObject

getProperties, getProperties, getProperties, getProperty, getProperty, getProperty, getProperty, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValues, getPropertyValues

Field Detail

ID_PROPERTY_NAME

static final String ID_PROPERTY_NAME

Meta property name used for operations such as sorting

See Also:

Constant Field Values

Method Detail

getId

String getId()

id of the element.

Specified by:

getId in interface VertexiumObject

getVisibility

Visibility getVisibility()

the visibility of the element.

getTimestamp

long getTimestamp()

The timestamp of when this element was updated.

getHistoricalPropertyValues

default Iterable<HistoricalPropertyValue> getHistoricalPropertyValues(Authorizations authorizations)

Gets all property values from all timestamps in descending timestamp order.

getHistoricalPropertyValues

default Iterable<HistoricalPropertyValue> getHistoricalPropertyValues(Long startTime,
                                                                      Long endTime,
                                                                      Authorizations authorizations)

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

getHistoricalPropertyValues

default Iterable<HistoricalPropertyValue> getHistoricalPropertyValues(String key,
                                                                      String name,
                                                                      Visibility visibility,
                                                                      Authorizations authorizations)

Gets property values from all 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.

getHistoricalPropertyValues

default 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.

Parameters:

key - the key of the property.

name - the name of the property.

visibility - The visibility of the property to get.

prepareMutation

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

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.

deleteProperty

default void deleteProperty(Property property,
                            Authorizations authorizations)

Permanently deletes a property from the element. Only properties which you have access to can be deleted using this method.

Parameters:

property - The property to delete.

deleteProperty

default void deleteProperty(String key,
                            String name,
                            Authorizations authorizations)

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.

deleteProperty

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

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.

deleteProperties

default void deleteProperties(String name,
                              Authorizations authorizations)

Permanently deletes all properties with the given name that you have access to. Only properties which you have access to will be deleted.

Parameters:

name - The name of the property to delete.

softDeleteProperty

default void softDeleteProperty(String key,
                                String name,
                                Authorizations authorizations)

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

Parameters:

key - The property key.

name - The property name.

softDeleteProperty

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. 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.

softDeleteProperties

default void softDeleteProperties(String name,
                                  Authorizations authorizations)

Soft deletes all properties with the given name that you have access to. Only properties which you have access to will be soft deleted.

Parameters:

name - The name of the property to delete.

getGraph

Graph getGraph()

Gets the graph that this element belongs to.

addPropertyValue

default void addPropertyValue(String key,
                              String name,
                              Object value,
                              Visibility visibility,
                              Authorizations authorizations)

Adds or updates a property.

Parameters:

key - The unique key given to the property allowing for multi-valued properties.

name - The name of the property.

value - The value of the property.

visibility - The visibility to give this property.

addPropertyValue

default void addPropertyValue(String key,
                              String name,
                              Object value,
                              Metadata metadata,
                              Visibility visibility,
                              Authorizations authorizations)

Adds or updates a property.

Parameters:

key - The unique key given to the property allowing for multi-valued properties.

name - The name of the property.

value - The value of the property.

metadata - The metadata to assign to this property.

visibility - The visibility to give this property.

setProperty

default void setProperty(String name,
                         Object value,
                         Visibility visibility,
                         Authorizations authorizations)

Sets or updates a property value. The property key will be set to a constant. This is a convenience method which allows treating the multi-valued nature of properties as only containing a single value. Care must be taken when using this method because properties are not only uniquely identified by just key and name but also visibility so adding properties with the same name and different visibility strings is still permitted.

Parameters:

name - The name of the property.

value - The value of the property.

visibility - The visibility to give this property.

setProperty

default void setProperty(String name,
                         Object value,
                         Metadata metadata,
                         Visibility visibility,
                         Authorizations authorizations)

Sets or updates a property value. The property key will be set to a constant. This is a convenience method which allows treating the multi-valued nature of properties as only containing a single value. Care must be taken when using this method because properties are not only uniquely identified by just key and name but also visibility so adding properties with the same name and different visibility strings is still permitted.

Parameters:

name - The name of the property.

value - The value of the property.

metadata - The metadata to assign to this property.

visibility - The visibility to give this property.

getAuthorizations

Authorizations getAuthorizations()

Gets the authorizations used to get this element.

markPropertyHidden

default void markPropertyHidden(String key,
                                String name,
                                Visibility propertyVisibility,
                                Visibility visibility,
                                Authorizations authorizations)

Marks a property as hidden for a given visibility.

Parameters:

key - The key of the property.

name - The name of the property.

propertyVisibility - The visibility of the property.

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.

markPropertyHidden

default void markPropertyHidden(String key,
                                String name,
                                Visibility propertyVisibility,
                                Long timestamp,
                                Visibility visibility,
                                Authorizations authorizations)

Marks a property as hidden for a given visibility.

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 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.

markPropertyHidden

default void markPropertyHidden(Property property,
                                Visibility visibility,
                                Authorizations authorizations)

Marks a property as hidden for a given visibility.

Parameters:

property - The property.

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.

markPropertyHidden

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

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

default void markPropertyVisible(String key,
                                 String name,
                                 Visibility propertyVisibility,
                                 Visibility visibility,
                                 Authorizations authorizations)

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.

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

authorizations - The authorizations used.

markPropertyVisible

default 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.

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.

markPropertyVisible

default void markPropertyVisible(Property property,
                                 Visibility visibility,
                                 Authorizations authorizations)

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

Parameters:

property - The property.

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

authorizations - The authorizations used.

markPropertyVisible

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

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.

isHidden

default boolean isHidden(Authorizations authorizations)

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.

getHiddenVisibilities

Iterable<Visibility> getHiddenVisibilities()

Gets the list of hidden visibilities

getExtendedDataTableNames

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

Gets the list of extended data table names.

getExtendedData

QueryableIterable<ExtendedDataRow> getExtendedData(String tableName)

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.

getFetchHints

FetchHints getFetchHints()

Fetch hints used when fetching this element.

compareTo

default int compareTo(Object o)

Specified by:

compareTo in interface Comparable