org.neolumin.vertexium

Interface Element

All Known Subinterfaces:

Edge, Vertex

All Known Implementing Classes:

ElementBase

public interface Element

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

Method Summary

Methods

Modifier and Type	Method and Description
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.
Authorizations	getAuthorizations() Gets the authorizations used to get this element.
Graph	getGraph() Gets the graph that this element belongs to.
String	getId() 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 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.
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.
Visibility	getVisibility() the visibility of the element.
boolean	isHidden(Authorizations authorizations) Given the supplied authorizations is this element hidden?
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, Visibility visibility, Authorizations authorizations) Marks a property as hidden for a given visibility.
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, 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.
<T extends Element> ExistingElementMutation<T>	prepareMutation() Prepares a mutation to allow changing multiple property values at the same time.
void	removeProperty(String name, Authorizations authorizations) Removes all properties with the given name that you have access to.
void	removeProperty(String key, String name, Authorizations authorizations) Removes a property given it's key and name from the element.
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.

Method Detail

getId

String getId()

id of the element.

getVisibility

Visibility getVisibility()

the visibility of the element.

getProperties

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.

getProperty

Property getProperty(String key,
                   String name)

Gets a property by key and name.

Parameters:

key - the key of the property.

name - the name of the property.

Returns:

The property if found. null, if not found.

getProperty

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

Gets a property by key, name, and visibility.

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

Property getProperty(String name,
                   Visibility visibility)

Gets a property by name, and visibility.

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

Property getProperty(String name)

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

Parameters:

name - the name of the property.

Returns:

The property if found. null, if not found.

getProperties

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.

Parameters:

name - The name of the property to retrieve

getProperties

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.

Parameters:

key - The property key

name - The name of the property to retrieve

getPropertyValues

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.

Parameters:

name - The name of the property to retrieve

getPropertyValues

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.

Parameters:

key - The property key

name - The name of the property to retrieve

getPropertyValue

Object getPropertyValue(String name)

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

Object getPropertyValue(String key,
                      String name)

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.

getPropertyValue

Object getPropertyValue(String name,
                      int index)

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.

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

Object getPropertyValue(String key,
                      String name,
                      int index)

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.

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.

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.

removeProperty

void removeProperty(String key,
                  String name,
                  Authorizations authorizations)

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

Parameters:

key - The property key.

name - The property name.

removeProperty

void removeProperty(String name,
                  Authorizations authorizations)

Removes all properties with the given name that you have access to. Only properties which you have access to will be removed.

Parameters:

name - The name of the property to remove.

getGraph

Graph getGraph()

Gets the graph that this element belongs to.

addPropertyValue

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

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

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

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.

mergeProperties

void mergeProperties(Element element)

Merge the given element's properties into this.

Parameters:

element - The element to merge properties from.

markPropertyHidden

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

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.

markPropertyVisible

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

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.

isHidden

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.