org.vertexium.mutation

Interface ExistingElementMutation<T extends Element>

All Superinterfaces:

ElementMutation<T>

All Known Implementing Classes:

ExistingEdgeMutation, ExistingElementMutationImpl

public interface ExistingElementMutation<T extends Element>
extends ElementMutation<T>

Field Summary

Fields inherited from interface org.vertexium.mutation.ElementMutation

DEFAULT_KEY

Method Summary

Modifier and Type	Method and Description
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 (assumes the property key is the DEFAULT).
ExistingElementMutation<T>	deleteProperties(String name) Permanently deletes all default properties with that name irregardless of visibility.
ExistingElementMutation<T>	deleteProperties(String key, String name) Permanently deletes all properties with this key and name irregardless of visibility.
List<AlterPropertyVisibility>	getAlterPropertyVisibilities() Gets the properties whose visibilities are being altered in this mutation.
T	getElement() Gets the element this mutation is affecting.
Visibility	getNewElementVisibility() Get the new element visibility or null if not being altered in this mutation.
Visibility	getOldElementVisibility() Get the old element visibility.
List<SetPropertyMetadata>	getSetPropertyMetadatas() Gets all of the property metadata changes that are part of this mutation.
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.
ExistingElementMutation<T>	softDeleteProperties(String name) Soft deletes all default properties with that name irregardless of visibility.
ExistingElementMutation<T>	softDeleteProperties(String key, String name) Soft deletes all properties with this key and name irregardless of visibility.

Methods inherited from interface org.vertexium.mutation.ElementMutation

addExtendedData, addExtendedData, addExtendedData, addExtendedData, addPropertyValue, addPropertyValue, addPropertyValue, deleteExtendedData, deleteExtendedData, deleteProperty, deleteProperty, deleteProperty, getExtendedData, getExtendedDataDeletes, getIndexHint, getProperties, getPropertyDeletes, getPropertySoftDeletes, hasChanges, save, setIndexHint, setProperty, setProperty, softDeleteProperty, softDeleteProperty, softDeleteProperty

Method Detail

alterPropertyVisibility

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

Alters the visibility of a property.

Parameters:

property - The property to mutate.

visibility - The new visibility.

alterPropertyVisibility

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

Alters the visibility of a property.

Parameters:

key - The key of a multivalued property.

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

visibility - The new visibility.

alterPropertyVisibility

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

Alters the visibility of a property (assumes the property key is the DEFAULT).

Parameters:

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

visibility - The new visibility.

getAlterPropertyVisibilities

List<AlterPropertyVisibility> getAlterPropertyVisibilities()

Gets the properties whose visibilities are being altered in this mutation.

alterElementVisibility

ExistingElementMutation<T> alterElementVisibility(Visibility visibility)

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

Parameters:

visibility - The new visibility.

getNewElementVisibility

Visibility getNewElementVisibility()

Get the new element visibility or null if not being altered in this mutation.

getOldElementVisibility

Visibility getOldElementVisibility()

Get the old element visibility.

setPropertyMetadata

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

Sets a property metadata value on a property.

Parameters:

property - The property to mutate.

metadataName - The name of the metadata.

newValue - The new value.

visibility - The visibility of the metadata item

setPropertyMetadata

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

Sets a property metadata value on a property.

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

setPropertyMetadata

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

Sets a property metadata value on a property.

Parameters:

propertyName - The name of the property.

metadataName - The name of the metadata.

newValue - The new value.

visibility - The visibility of the metadata item

getSetPropertyMetadatas

List<SetPropertyMetadata> getSetPropertyMetadatas()

Gets all of the property metadata changes that are part of this mutation.

deleteProperties

ExistingElementMutation<T> deleteProperties(String name)

Permanently deletes all default properties with that name irregardless of visibility.

Parameters:

name - the property name to delete.

deleteProperties

ExistingElementMutation<T> deleteProperties(String key,
                                            String name)

Permanently deletes all properties with this key and name irregardless of visibility.

Parameters:

key - the key of the property to delete.

name - the name of the property to delete.

softDeleteProperties

ExistingElementMutation<T> softDeleteProperties(String name)

Soft deletes all default properties with that name irregardless of visibility.

Parameters:

name - the property name to delete.

softDeleteProperties

ExistingElementMutation<T> softDeleteProperties(String key,
                                                String name)

Soft deletes all properties with this key and name irregardless of visibility.

Parameters:

key - the key of the property to delete.

name - the name of the property to delete.

getElement

T getElement()

Gets the element this mutation is affecting.

Returns:

The element.