org.vertexium

Class ElementBase

java.lang.Object

org.vertexium.ElementBase

All Implemented Interfaces:

Element

public abstract class ElementBase
extends Object
implements Element

Field Summary

Fields inherited from interface org.vertexium.Element

ID_PROPERTY_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ElementBase(Graph graph, String id, Visibility visibility, Iterable<Property> properties, Iterable<PropertyDeleteMutation> propertyDeleteMutations, Iterable<PropertySoftDeleteMutation> propertySoftDeleteMutations, Iterable<Visibility> hiddenVisibilities, long timestamp, Authorizations authorizations)

Method Summary

Modifier and Type	Method and Description
protected void	addPropertyInternal(Property property)
void	addPropertyValue(String key, String name, Object value, Metadata metadata, Visibility visibility, Authorizations authorizations) Adds or updates a property.
void	addPropertyValue(String key, String name, Object value, Visibility visibility, Authorizations authorizations) Adds or updates a property.
abstract void	deleteProperties(String name, Authorizations authorizations) Permanently deletes all properties with the given name that you have access to.
abstract void	deleteProperty(String key, String name, Authorizations authorizations) Permanently deletes a property given it's key and name from the element.
abstract 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.
protected Property	getEdgeLabelProperty()
Graph	getGraph() Gets the graph that this element belongs to.
Iterable<Visibility>	getHiddenVisibilities() Gets the list of hidden visibilities
Iterable<HistoricalPropertyValue>	getHistoricalPropertyValues(Authorizations authorizations) Gets all property values from all timestamps in descending timestamp order.
Iterable<HistoricalPropertyValue>	getHistoricalPropertyValues(Long startTime, Long endTime, Authorizations authorizations) Gets all property values from the given range of timestamps in descending timestamp order.
Iterable<HistoricalPropertyValue>	getHistoricalPropertyValues(String key, String name, Visibility visibility, Authorizations authorizations) Gets property values from all timestamps in descending timestamp order.
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.
protected Property	getIdProperty()
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 name) an Iterable of all the properties with the given name 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 name) Gets a property by name.
Property	getProperty(String key, String name) Gets a property by key and name.
Property	getProperty(String key, String name, Visibility visibility) Gets a property by key, name, and visibility.
Property	getProperty(String name, Visibility visibility) Gets a property by name, and visibility.
Iterable<PropertyDeleteMutation>	getPropertyDeleteMutations()
Iterable<PropertySoftDeleteMutation>	getPropertySoftDeleteMutations()
Object	getPropertyValue(String name) Convenience method to retrieve the first value of the property with the given name.
Object	getPropertyValue(String name, int index) Gets the nth property value of the named property.
Object	getPropertyValue(String key, String name) Convenience method to retrieve the first value of the property with the given name.
Object	getPropertyValue(String key, String name, int index) Gets the nth property value of the named property.
Iterable<Object>	getPropertyValues(String name) an Iterable of all the property values with the given name on this element that you have access to based on the authorizations used to retrieve the element.
Iterable<Object>	getPropertyValues(String key, String name) an Iterable of all the property values with the given name and key 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.
Visibility	getVisibility() the visibility of the element.
int	hashCode()
boolean	isHidden(Authorizations authorizations) Given the supplied authorizations is this element hidden?
abstract void	markPropertyHidden(Property property, Long timestamp, Visibility visibility, Authorizations authorizations) Marks a property as hidden for a given visibility.
void	markPropertyHidden(Property property, Visibility visibility, Authorizations authorizations) Marks a property as hidden for a given visibility.
void	markPropertyHidden(String key, String name, Visibility propertyVisibility, Long timestamp, Visibility visibility, Authorizations authorizations) Marks a property as hidden for a given visibility.
void	markPropertyHidden(String key, String name, Visibility propertyVisibility, Visibility visibility, Authorizations authorizations) Marks a property as hidden for a given visibility.
abstract void	markPropertyVisible(Property property, Long timestamp, Visibility visibility, Authorizations authorizations) Marks a property as visible for a given visibility, effectively undoing markPropertyHidden.
void	markPropertyVisible(Property property, 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.
void	markPropertyVisible(String key, String name, Visibility propertyVisibility, Visibility visibility, Authorizations authorizations) Marks a property as visible for a given visibility, effectively undoing markPropertyHidden.
void	mergeProperties(Element element) Merge the given element's properties into this.
abstract <T extends Element> ExistingElementMutation<T>	prepareMutation() Prepares a mutation to allow changing multiple property values at the same time.
protected Iterable<Property>	removePropertyInternal(String name)
protected Property	removePropertyInternal(String key, String name)
protected Property	removePropertyInternal(String key, String name, Visibility visibility)
void	setProperty(String name, Object value, Metadata metadata, Visibility visibility, Authorizations authorizations) Sets or updates a property value.
void	setProperty(String name, Object value, Visibility visibility, Authorizations authorizations) Sets or updates a property value.
protected void	setVisibility(Visibility visibility)
abstract void	softDeleteProperties(String name, Authorizations authorizations) Soft deletes all properties with the given name that you have access to.
abstract void	softDeleteProperty(String key, String name, Authorizations authorizations) Soft deletes a property given it's key and name from the element.
abstract 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 Property	softDeletePropertyInternal(String key, String name)
protected Property	softDeletePropertyInternal(String key, String name, Visibility visibility)
String	toString()
protected void	updatePropertiesInternal(Iterable<Property> properties, Iterable<PropertyDeleteMutation> propertyDeleteMutations, Iterable<PropertySoftDeleteMutation> propertySoftDeleteMutations)

Methods inherited from class java.lang.Object

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

Constructor Detail

ElementBase

protected ElementBase(Graph graph,
                      String id,
                      Visibility visibility,
                      Iterable<Property> properties,
                      Iterable<PropertyDeleteMutation> propertyDeleteMutations,
                      Iterable<PropertySoftDeleteMutation> propertySoftDeleteMutations,
                      Iterable<Visibility> hiddenVisibilities,
                      long timestamp,
                      Authorizations authorizations)

Method Detail

getPropertyValues

public Iterable<Object> getPropertyValues(String name)

Description copied from interface: Element

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

Specified by:

getPropertyValues in interface Element

Parameters:

name - The name of the property to retrieve

getPropertyValues

public Iterable<Object> getPropertyValues(String key,
                                          String name)

Description copied from interface: Element

an Iterable of all the property values 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:

getPropertyValues in interface Element

Parameters:

key - The property key

name - The name of the property to retrieve

getProperty

public Property getProperty(String name,
                            Visibility visibility)

Description copied from interface: Element

Gets a property by name, and visibility.

Specified by:

getProperty in interface Element

Parameters:

name - the name of the property.

visibility - The visibility of the property to get.

Returns:

The property if found. null, if not found.

getProperty

public Property getProperty(String key,
                            String name,
                            Visibility visibility)

Description copied from interface: Element

Gets a property by key, name, and visibility.

Specified by:

getProperty in interface Element

Parameters:

key - the key of the property.

name - the name of the property.

visibility - The visibility of the property to get.

Returns:

The property if found. null, if not found.

getProperty

public Property getProperty(String key,
                            String name)

Description copied from interface: Element

Gets a property by key and name.

Specified by:

getProperty in interface Element

Parameters:

key - the key of the property.

name - the name of the property.

Returns:

The property if found. null, if not found.

getProperty

public Property getProperty(String name)

Description copied from interface: Element

Gets a property by name. This assumes a single valued property. If multiple property values exists this will only return the first one.

Specified by:

getProperty in interface Element

Parameters:

name - the name of the property.

Returns:

The property if found. null, if not found.

getPropertyValue

public Object getPropertyValue(String name)

Description copied from interface: Element

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.

Specified by:

getPropertyValue in interface Element

Parameters:

name - The name of the property to retrieve

Returns:

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

getPropertyValue

public Object getPropertyValue(String name,
                               int index)

Description copied from interface: Element

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 Element

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 Object getPropertyValue(String key,
                               String name,
                               int index)

Description copied from interface: Element

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 Element

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.

getPropertyValue

public Object getPropertyValue(String key,
                               String name)

Description copied from interface: Element

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.

Specified by:

getPropertyValue in interface Element

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.

getId

public String getId()

Description copied from interface: Element

id of the element.

Specified by:

getId in interface Element

getIdProperty

protected Property getIdProperty()

getEdgeLabelProperty

protected Property getEdgeLabelProperty()

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

setVisibility

protected void setVisibility(Visibility visibility)

getProperties

public Iterable<Property> getProperties()

Description copied from interface: Element

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 Element

getPropertyDeleteMutations

public Iterable<PropertyDeleteMutation> getPropertyDeleteMutations()

getPropertySoftDeleteMutations

public Iterable<PropertySoftDeleteMutation> getPropertySoftDeleteMutations()

getProperties

public Iterable<Property> getProperties(String name)

Description copied from interface: Element

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

Specified by:

getProperties in interface Element

Parameters:

name - The name of the property to retrieve

getProperties

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

Description copied from interface: Element

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 Element

Parameters:

key - The property key

name - The name of the property to retrieve

updatePropertiesInternal

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

addPropertyInternal

protected void addPropertyInternal(Property property)

removePropertyInternal

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

removePropertyInternal

protected Property removePropertyInternal(String key,
                                          String name)

softDeletePropertyInternal

protected Property softDeletePropertyInternal(String key,
                                              String name)

softDeletePropertyInternal

protected Property softDeletePropertyInternal(String key,
                                              String name,
                                              Visibility visibility)

removePropertyInternal

protected Iterable<Property> removePropertyInternal(String name)

getGraph

public Graph getGraph()

Description copied from interface: Element

Gets the graph that this element belongs to.

Specified by:

getGraph in interface Element

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

deleteProperty

public abstract void deleteProperty(String key,
                                    String name,
                                    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.

deleteProperties

public abstract void deleteProperties(String name,
                                      Authorizations authorizations)

Description copied from interface: Element

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

Specified by:

deleteProperties in interface Element

Parameters:

name - The name of the property to delete.

softDeleteProperty

public abstract void softDeleteProperty(String key,
                                        String name,
                                        Authorizations authorizations)

Description copied from interface: Element

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.

Specified by:

softDeleteProperty in interface Element

Parameters:

key - The property key.

name - The property name.

softDeleteProperty

public abstract 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 abstract void softDeleteProperties(String name,
                                          Authorizations authorizations)

Description copied from interface: Element

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

Specified by:

softDeleteProperties in interface Element

Parameters:

name - The name of the property to delete.

addPropertyValue

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

Description copied from interface: Element

Adds or updates a property.

Specified by:

addPropertyValue in interface Element

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

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

Description copied from interface: Element

Adds or updates a property.

Specified by:

addPropertyValue in interface Element

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

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

Description copied from interface: Element

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.

Specified by:

setProperty in interface Element

Parameters:

name - The name of the property.

value - The value of the property.

visibility - The visibility to give this property.

setProperty

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

Description copied from interface: Element

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.

Specified by:

setProperty in interface Element

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.

markPropertyHidden

public void markPropertyHidden(String key,
                               String name,
                               Visibility propertyVisibility,
                               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:

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

public void markPropertyHidden(String key,
                               String name,
                               Visibility propertyVisibility,
                               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:

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

public void markPropertyHidden(Property property,
                               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.

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

Specified by:

markPropertyVisible in interface Element

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

public void markPropertyVisible(String key,
                                String name,
                                Visibility propertyVisibility,
                                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:

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

public void markPropertyVisible(Property property,
                                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.

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

authorizations - The authorizations used.

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.

markPropertyHidden

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

getAuthorizations

public Authorizations getAuthorizations()

Description copied from interface: Element

Gets the authorizations used to get this element.

Specified by:

getAuthorizations in interface Element

mergeProperties

public void mergeProperties(Element element)

Description copied from interface: Element

Merge the given element's properties into this.

Specified by:

mergeProperties in interface Element

Parameters:

element - The element to merge properties from.

getHiddenVisibilities

public Iterable<Visibility> getHiddenVisibilities()

Description copied from interface: Element

Gets the list of hidden visibilities

Specified by:

getHiddenVisibilities in interface Element

isHidden

public boolean isHidden(Authorizations authorizations)

Description copied from interface: Element

Given the supplied authorizations is this element hidden?

Specified by:

isHidden in interface Element

Parameters:

authorizations - the authorizations to check against.

Returns:

true, if it would be hidden from those authorizations.

deleteProperty

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

getHistoricalPropertyValues

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

Description copied from interface: Element

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

Specified by:

getHistoricalPropertyValues in interface Element

getHistoricalPropertyValues

public Iterable<HistoricalPropertyValue> getHistoricalPropertyValues(Authorizations authorizations)

Description copied from interface: Element

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

Specified by:

getHistoricalPropertyValues in interface Element

getHistoricalPropertyValues

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

Description copied from interface: Element

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

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.