org.neolumin.vertexium.mutation

Interface ElementMutation<T extends Element>

All Known Subinterfaces:

EdgeMutation, ExistingElementMutation<T>

All Known Implementing Classes:

EdgeBuilder, EdgeBuilderBase, EdgeBuilderByVertexId, ElementBuilder, ExistingEdgeMutation, ExistingElementMutationImpl, VertexBuilder

public interface ElementMutation<T extends Element>

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_KEY

Method Summary

Methods

Modifier and Type	Method and Description
ElementMutation<T>	addPropertyValue(String key, String name, Object value, Metadata metadata, Visibility visibility) Adds or updates a property.
ElementMutation<T>	addPropertyValue(String key, String name, Object value, Visibility visibility) Adds or updates a property.
Iterable<Property>	getProperties() Gets the properties currently in this mutation.
Iterable<PropertyRemoveMutation>	getPropertyRemoves() Gets the properties currently being removed in this mutation.
ElementMutation<T>	removeProperty(Property property) Removes a property.
ElementMutation<T>	removeProperty(String key, String name, Visibility visibility) Removes a property.
ElementMutation<T>	removeProperty(String name, Visibility visibility) Removes the default property with that name.
T	save(Authorizations authorizations) saves the properties to the graph.
ElementMutation<T>	setIndexHint(IndexHint indexHint) Sets the index hint of this element.
ElementMutation<T>	setProperty(String name, Object value, Metadata metadata, Visibility visibility) Sets or updates a property value.
ElementMutation<T>	setProperty(String name, Object value, Visibility visibility) Sets or updates a property value.

Field Detail

DEFAULT_KEY

static final String DEFAULT_KEY

See Also:

Constant Field Values

Method Detail

save

T save(Authorizations authorizations)

saves the properties to the graph.

Returns:

the element which was mutated.

setProperty

ElementMutation<T> setProperty(String name,
                             Object value,
                             Visibility visibility)

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

ElementMutation<T> setProperty(String name,
                             Object value,
                             Metadata metadata,
                             Visibility visibility)

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.

addPropertyValue

ElementMutation<T> addPropertyValue(String key,
                                  String name,
                                  Object value,
                                  Visibility visibility)

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

ElementMutation<T> addPropertyValue(String key,
                                  String name,
                                  Object value,
                                  Metadata metadata,
                                  Visibility visibility)

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.

removeProperty

ElementMutation<T> removeProperty(Property property)

Removes a property.

Parameters:

property - the property to remove.

removeProperty

ElementMutation<T> removeProperty(String name,
                                Visibility visibility)

Removes the default property with that name.

Parameters:

name - the property name to remove.

visibility - the visibility of the property to remove.

removeProperty

ElementMutation<T> removeProperty(String key,
                                String name,
                                Visibility visibility)

Removes a property.

Parameters:

key - the key of the property to remove.

name - the name of the property to remove.

visibility - the visibility of the property to remove.

getProperties

Iterable<Property> getProperties()

Gets the properties currently in this mutation.

getPropertyRemoves

Iterable<PropertyRemoveMutation> getPropertyRemoves()

Gets the properties currently being removed in this mutation.

setIndexHint

ElementMutation<T> setIndexHint(IndexHint indexHint)

Sets the index hint of this element.