org.neolumin.vertexium.mutation

Class ExistingElementMutationImpl<T extends Element>

java.lang.Object

org.neolumin.vertexium.mutation.ExistingElementMutationImpl<T>

All Implemented Interfaces:

ElementMutation<T>, ExistingElementMutation<T>

Direct Known Subclasses:

ExistingEdgeMutation

public abstract class ExistingElementMutationImpl<T extends Element>
extends Object
implements ElementMutation<T>, ExistingElementMutation<T>

Field Summary

Fields inherited from interface org.neolumin.vertexium.mutation.ElementMutation

DEFAULT_KEY

Constructor Summary

Constructors

Constructor and Description
ExistingElementMutationImpl(T element)

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.
ExistingElementMutation<T>	alterElementVisibility(Visibility visibility) Alters the visibility of the element (vertex or edge).
ExistingElementMutation<T>	alterPropertyVisibility(Property property, Visibility visibility) Alters the visibility of a property.
ExistingElementMutation<T>	alterPropertyVisibility(String key, String name, Visibility visibility) Alters the visibility of a property.
ExistingElementMutation<T>	alterPropertyVisibility(String name, Visibility visibility) Alters the visibility of a property.
List<AlterPropertyVisibility>	getAlterPropertyVisibilities()
T	getElement() Gets the element this mutation is affecting.
IndexHint	getIndexHint()
Visibility	getNewElementVisibility()
Iterable<Property>	getProperties() Gets the properties currently in this mutation.
Iterable<PropertyRemoveMutation>	getPropertyRemoves() Gets the properties currently being removed in this mutation.
List<SetPropertyMetadata>	getSetPropertyMetadatas()
ExistingElementMutation<T>	removeProperties(String name) Removes all default properties with that name irregardless of visibility.
ExistingElementMutation<T>	removeProperties(String key, String name) Removes all properties with this key and name irregardless of visibility.
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.
abstract 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.
ExistingElementMutation<T>	setPropertyMetadata(Property property, String metadataName, Object newValue, Visibility visibility) Sets a property metadata value on a property.
ExistingElementMutation<T>	setPropertyMetadata(String propertyName, String metadataName, Object newValue, Visibility visibility) Sets a property metadata value on a property.
ExistingElementMutation<T>	setPropertyMetadata(String propertyKey, String propertyName, String metadataName, Object newValue, Visibility visibility) Sets a property metadata value on a property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExistingElementMutationImpl

public ExistingElementMutationImpl(T element)

Method Detail

save

public abstract T save(Authorizations authorizations)

Description copied from interface: ElementMutation

saves the properties to the graph.

Specified by:

save in interface ElementMutation<T extends Element>

Returns:

the element which was mutated.

setProperty

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

Description copied from interface: ElementMutation

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 ElementMutation<T extends Element>

Parameters:

name - The name of the property.

value - The value of the property.

visibility - The visibility to give this property.

setProperty

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

Description copied from interface: ElementMutation

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 ElementMutation<T extends 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.

addPropertyValue

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

Description copied from interface: ElementMutation

Adds or updates a property.

Specified by:

addPropertyValue in interface ElementMutation<T extends 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 ElementMutation<T> addPropertyValue(String key,
                                  String name,
                                  Object value,
                                  Metadata metadata,
                                  Visibility visibility)

Description copied from interface: ElementMutation

Adds or updates a property.

Specified by:

addPropertyValue in interface ElementMutation<T extends 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.

getProperties

public Iterable<Property> getProperties()

Description copied from interface: ElementMutation

Gets the properties currently in this mutation.

Specified by:

getProperties in interface ElementMutation<T extends Element>

getPropertyRemoves

public Iterable<PropertyRemoveMutation> getPropertyRemoves()

Description copied from interface: ElementMutation

Gets the properties currently being removed in this mutation.

Specified by:

getPropertyRemoves in interface ElementMutation<T extends Element>

removeProperty

public ElementMutation<T> removeProperty(Property property)

Description copied from interface: ElementMutation

Removes a property.

Specified by:

removeProperty in interface ElementMutation<T extends Element>

Parameters:

property - the property to remove.

removeProperties

public ExistingElementMutation<T> removeProperties(String name)

Description copied from interface: ExistingElementMutation

Removes all default properties with that name irregardless of visibility.

Specified by:

removeProperties in interface ExistingElementMutation<T extends Element>

Parameters:

name - the property name to remove.

removeProperties

public ExistingElementMutation<T> removeProperties(String key,
                                          String name)

Description copied from interface: ExistingElementMutation

Removes all properties with this key and name irregardless of visibility.

Specified by:

removeProperties in interface ExistingElementMutation<T extends Element>

Parameters:

key - the key of the property to remove.

name - the name of the property to remove.

removeProperty

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

Description copied from interface: ElementMutation

Removes the default property with that name.

Specified by:

removeProperty in interface ElementMutation<T extends Element>

Parameters:

name - the property name to remove.

visibility - the visibility of the property to remove.

removeProperty

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

Description copied from interface: ElementMutation

Removes a property.

Specified by:

removeProperty in interface ElementMutation<T extends Element>

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.

alterPropertyVisibility

public ExistingElementMutation<T> alterPropertyVisibility(Property property,
                                                 Visibility visibility)

Description copied from interface: ExistingElementMutation

Alters the visibility of a property.

Specified by:

alterPropertyVisibility in interface ExistingElementMutation<T extends Element>

Parameters:

property - The property to mutate.

visibility - The new visibility.

alterPropertyVisibility

public ExistingElementMutation<T> alterPropertyVisibility(String name,
                                                 Visibility visibility)

Description copied from interface: ExistingElementMutation

Alters the visibility of a property.

Specified by:

alterPropertyVisibility in interface ExistingElementMutation<T extends Element>

Parameters:

name - The name of the property to alter the visibility of.

visibility - The new visibility.

alterPropertyVisibility

public ExistingElementMutation<T> alterPropertyVisibility(String key,
                                                 String name,
                                                 Visibility visibility)

Description copied from interface: ExistingElementMutation

Alters the visibility of a property.

Specified by:

alterPropertyVisibility in interface ExistingElementMutation<T extends Element>

Parameters:

key - The key of a multivalued property.

name - The name of the property to alter the visibility of.

visibility - The new visibility.

alterElementVisibility

public ExistingElementMutation<T> alterElementVisibility(Visibility visibility)

Description copied from interface: ExistingElementMutation

Alters the visibility of the element (vertex or edge).

Specified by:

alterElementVisibility in interface ExistingElementMutation<T extends Element>

Parameters:

visibility - The new visibility.

setPropertyMetadata

public ExistingElementMutation<T> setPropertyMetadata(Property property,
                                             String metadataName,
                                             Object newValue,
                                             Visibility visibility)

Description copied from interface: ExistingElementMutation

Sets a property metadata value on a property.

Specified by:

setPropertyMetadata in interface ExistingElementMutation<T extends Element>

Parameters:

property - The property to mutate.

metadataName - The name of the metadata.

newValue - The new value.

visibility - The visibility of the metadata item

setPropertyMetadata

public ExistingElementMutation<T> setPropertyMetadata(String propertyName,
                                             String metadataName,
                                             Object newValue,
                                             Visibility visibility)

Description copied from interface: ExistingElementMutation

Sets a property metadata value on a property.

Specified by:

setPropertyMetadata in interface ExistingElementMutation<T extends Element>

Parameters:

propertyName - The name of the property.

metadataName - The name of the metadata.

newValue - The new value.

visibility - The visibility of the metadata item

setPropertyMetadata

public ExistingElementMutation<T> setPropertyMetadata(String propertyKey,
                                             String propertyName,
                                             String metadataName,
                                             Object newValue,
                                             Visibility visibility)

Description copied from interface: ExistingElementMutation

Sets a property metadata value on a property.

Specified by:

setPropertyMetadata in interface ExistingElementMutation<T extends Element>

Parameters:

propertyKey - The key of a multivalued property.

propertyName - The name of the property.

metadataName - The name of the metadata.

newValue - The new value.

visibility - The visibility of the metadata item

getElement

public T getElement()

Description copied from interface: ExistingElementMutation

Gets the element this mutation is affecting.

Specified by:

getElement in interface ExistingElementMutation<T extends Element>

Returns:

The element.

getNewElementVisibility

public Visibility getNewElementVisibility()

getAlterPropertyVisibilities

public List<AlterPropertyVisibility> getAlterPropertyVisibilities()

getSetPropertyMetadatas

public List<SetPropertyMetadata> getSetPropertyMetadatas()

getIndexHint

public IndexHint getIndexHint()

setIndexHint

public ElementMutation<T> setIndexHint(IndexHint indexHint)

Description copied from interface: ElementMutation

Sets the index hint of this element.

Specified by:

setIndexHint in interface ElementMutation<T extends Element>