org.vertexium

Class EdgeInfoEdge

java.lang.Object

org.vertexium.ElementBase

org.vertexium.EdgeInfoEdge

All Implemented Interfaces:

Comparable, Edge, Element, VertexiumObject

public class EdgeInfoEdge
extends ElementBase
implements Edge

Field Summary

Fields inherited from interface org.vertexium.Edge

IN_OR_OUT_VERTEX_ID_PROPERTY_NAME, IN_VERTEX_ID_PROPERTY_NAME, LABEL_PROPERTY_NAME, OUT_VERTEX_ID_PROPERTY_NAME

Fields inherited from interface org.vertexium.Element

ID_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
EdgeInfoEdge(Graph graph, String sourceVertexId, EdgeInfo edgeInfo, FetchHints fetchHints, Authorizations authorizations)

Method Summary

Modifier and Type	Method and Description
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) 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
String	getId() id of the element.
String	getLabel() The edge label.
String	getOtherVertexId(String myVertexId) Given a vertexId that represents one side of a relationship, get me the id of the other side.
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.
long	getTimestamp() The timestamp of when this element was updated.
String	getVertexId(Direction direction) Get the attach vertex id on either side of the edge.
Visibility	getVisibility() the visibility of the element.
int	hashCode()
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.
ExistingEdgeMutation	prepareMutation() Prepares a mutation to allow changing multiple property values at the same time.
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()

Methods inherited from class org.vertexium.ElementBase

getEdgeLabelProperty, getIdProperty, getInOrOutVertexIdProperty, getInVertexIdProperty, getOutVertexIdProperty, getProperties, getProperties, getProperty, getProperty, internalGetProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.vertexium.Edge

getOtherVertex, getOtherVertex, getVertex, getVertex, getVertices, getVertices

Methods inherited from interface org.vertexium.Element

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

Methods inherited from interface org.vertexium.VertexiumObject

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

Constructor Detail

EdgeInfoEdge

public EdgeInfoEdge(Graph graph,
                    String sourceVertexId,
                    EdgeInfo edgeInfo,
                    FetchHints fetchHints,
                    Authorizations authorizations)

Method Detail

getLabel

public String getLabel()

Description copied from interface: Edge

The edge label.

Specified by:

getLabel in interface Edge

getVertexId

public String getVertexId(Direction direction)

Description copied from interface: Edge

Get the attach vertex id on either side of the edge.

Specified by:

getVertexId in interface Edge

Parameters:

direction - The side of the edge to get the vertex id from (IN or OUT).

Returns:

The id of the vertex.

getOtherVertexId

public String getOtherVertexId(String myVertexId)

Description copied from interface: Edge

Given a vertexId that represents one side of a relationship, get me the id of the other side.

Specified by:

getOtherVertexId in interface Edge

prepareMutation

public ExistingEdgeMutation prepareMutation()

Description copied from interface: Edge

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

Specified by:

prepareMutation in interface Edge

Specified by:

prepareMutation in interface Element

Returns:

The mutation builder.

getId

public String getId()

Description copied from interface: Element

id of the element.

Specified by:

getId in interface Element

Specified by:

getId in interface VertexiumObject

getProperties

public Iterable<Property> getProperties()

Description copied from interface: VertexiumObject

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 VertexiumObject

getVisibility

public Visibility getVisibility()

Description copied from interface: Element

the visibility of the element.

Specified by:

getVisibility in interface Element

getTimestamp

public long getTimestamp()

Description copied from interface: Element

The timestamp of when this element was updated.

Specified by:

getTimestamp in interface Element

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.

getGraph

public Graph getGraph()

Description copied from interface: Element

Gets the graph that this element belongs to.

Specified by:

getGraph in interface Element

getAuthorizations

public Authorizations getAuthorizations()

Description copied from interface: Element

Gets the authorizations used to get this element.

Specified by:

getAuthorizations in interface Element

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.

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 list of extended data table names.

Specified by:

getExtendedDataTableNames in interface Element

getExtendedData

public QueryableIterable<ExtendedDataRow> getExtendedData(String tableName)

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.

getFetchHints

public FetchHints getFetchHints()

Description copied from interface: Element

Fetch hints used when fetching this element.

Specified by:

getFetchHints in interface Element

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object