ExistingElementMutationImpl (Vertexium: Core 2.5.7 API)

java.lang.Object
- org.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.vertexium.mutation.ElementMutation
  DEFAULT_KEY

Constructor Summary

Constructors
Constructor and Description

ExistingElementMutationImpl(T element)

Constructors
Constructor and Description
`ExistingElementMutationImpl(T element)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`ElementMutation<T>`	`addPropertyValue(String key, String name, Object value, Metadata metadata, Long timestamp, Visibility visibility)` Adds or updates a property.
`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.
`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.
`ElementMutation<T>`	`deleteProperty(Property property)` Deletes a property.
`ElementMutation<T>`	`deleteProperty(String key, String name, Visibility visibility)` Deletes a property.
`ElementMutation<T>`	`deleteProperty(String name, Visibility visibility)` Deletes the default property with that name.
`List<AlterPropertyVisibility>`	`getAlterPropertyVisibilities()`
`T`	`getElement()` Gets the element this mutation is affecting.
`IndexHint`	`getIndexHint()` Gets the currently set index hint.
`Visibility`	`getNewElementVisibility()`
`Iterable<Property>`	`getProperties()` Gets the properties currently in this mutation.
`Iterable<PropertyDeleteMutation>`	`getPropertyDeletes()` Gets the properties currently being deleted in this mutation.
`Iterable<PropertySoftDeleteMutation>`	`getPropertySoftDeletes()` Gets the properties currently being soft deleted in this mutation.
`List<SetPropertyMetadata>`	`getSetPropertyMetadatas()`
`boolean`	`hasChanges()` true, if this mutation has any changes.
`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.
`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.
`ElementMutation<T>`	`softDeleteProperty(Property property)` Soft deletes a property.
`ElementMutation<T>`	`softDeleteProperty(String key, String name, Visibility visibility)` Soft deletes a property.
`ElementMutation<T>`	`softDeleteProperty(String name, Visibility visibility)` Soft deletes the default property with that name.

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.
  - addPropertyValue
```
public ElementMutation<T> addPropertyValue(String key,
                                           String name,
                                           Object value,
                                           Metadata metadata,
                                           Long timestamp,
                                           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.
    
    timestamp - The timestamp of the 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>
  - getPropertyDeletes
```
public Iterable<PropertyDeleteMutation> getPropertyDeletes()
```
    Description copied from interface: ElementMutation
    
    Gets the properties currently being deleted in this mutation.
    
    Specified by:
    
    getPropertyDeletes in interface ElementMutation<T extends Element>
  - getPropertySoftDeletes
```
public Iterable<PropertySoftDeleteMutation> getPropertySoftDeletes()
```
    Description copied from interface: ElementMutation
    
    Gets the properties currently being soft deleted in this mutation.
    
    Specified by:
    
    getPropertySoftDeletes in interface ElementMutation<T extends Element>
  - deleteProperty
```
public ElementMutation<T> deleteProperty(Property property)
```
    Description copied from interface: ElementMutation
    
    Deletes a property.
    
    Specified by:
    
    deleteProperty in interface ElementMutation<T extends Element>
    
    Parameters:
    
    property - the property to delete.
  - deleteProperties
```
public ExistingElementMutation<T> deleteProperties(String name)
```
    Description copied from interface: ExistingElementMutation
    
    Permanently deletes all default properties with that name irregardless of visibility.
    
    Specified by:
    
    deleteProperties in interface ExistingElementMutation<T extends Element>
    
    Parameters:
    
    name - the property name to delete.
  - deleteProperties
```
public ExistingElementMutation<T> deleteProperties(String key,
                                                   String name)
```
    Description copied from interface: ExistingElementMutation
    
    Permanently deletes all properties with this key and name irregardless of visibility.
    
    Specified by:
    
    deleteProperties in interface ExistingElementMutation<T extends Element>
    
    Parameters:
    
    key - the key of the property to delete.
    
    name - the name of the property to delete.
  - deleteProperty
```
public ElementMutation<T> deleteProperty(String name,
                                         Visibility visibility)
```
    Description copied from interface: ElementMutation
    
    Deletes the default property with that name.
    
    Specified by:
    
    deleteProperty in interface ElementMutation<T extends Element>
    
    Parameters:
    
    name - the property name to delete.
    
    visibility - the visibility of the property to delete.
  - deleteProperty
```
public ElementMutation<T> deleteProperty(String key,
                                         String name,
                                         Visibility visibility)
```
    Description copied from interface: ElementMutation
    
    Deletes a property.
    
    Specified by:
    
    deleteProperty in interface ElementMutation<T extends Element>
    
    Parameters:
    
    key - the key of the property to delete.
    
    name - the name of the property to delete.
    
    visibility - the visibility of the property to delete.
  - softDeleteProperty
```
public ElementMutation<T> softDeleteProperty(Property property)
```
    Description copied from interface: ElementMutation
    
    Soft deletes a property.
    
    Specified by:
    
    softDeleteProperty in interface ElementMutation<T extends Element>
    
    Parameters:
    
    property - the property to soft delete.
  - softDeleteProperties
```
public ExistingElementMutation<T> softDeleteProperties(String name)
```
    Description copied from interface: ExistingElementMutation
    
    Soft deletes all default properties with that name irregardless of visibility.
    
    Specified by:
    
    softDeleteProperties in interface ExistingElementMutation<T extends Element>
    
    Parameters:
    
    name - the property name to delete.
  - softDeleteProperties
```
public ExistingElementMutation<T> softDeleteProperties(String key,
                                                       String name)
```
    Description copied from interface: ExistingElementMutation
    
    Soft deletes all properties with this key and name irregardless of visibility.
    
    Specified by:
    
    softDeleteProperties in interface ExistingElementMutation<T extends Element>
    
    Parameters:
    
    key - the key of the property to delete.
    
    name - the name of the property to delete.
  - softDeleteProperty
```
public ElementMutation<T> softDeleteProperty(String name,
                                             Visibility visibility)
```
    Description copied from interface: ElementMutation
    
    Soft deletes the default property with that name.
    
    Specified by:
    
    softDeleteProperty in interface ElementMutation<T extends Element>
    
    Parameters:
    
    name - the property name to soft delete.
    
    visibility - the visibility of the property to soft delete.
  - softDeleteProperty
```
public ElementMutation<T> softDeleteProperty(String key,
                                             String name,
                                             Visibility visibility)
```
    Description copied from interface: ElementMutation
    
    Soft deletes a property.
    
    Specified by:
    
    softDeleteProperty in interface ElementMutation<T extends Element>
    
    Parameters:
    
    key - the key of the property to soft delete.
    
    name - the name of the property to soft delete.
    
    visibility - the visibility of the property to soft delete.
  - 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()
```
    Description copied from interface: ElementMutation
    
    Gets the currently set index hint.
    
    Specified by:
    
    getIndexHint in interface ElementMutation<T extends Element>
  - 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>
  - hasChanges
```
public boolean hasChanges()
```
    Description copied from interface: ElementMutation
    
    true, if this mutation has any changes. false, if this mutation is empty.
    
    Specified by:
    
    hasChanges in interface ElementMutation<T extends Element>

Class ExistingElementMutationImpl<T extends Element>

Field Summary

Fields inherited from interface org.vertexium.mutation.ElementMutation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ExistingElementMutationImpl

Method Detail

save

setProperty

setProperty

addPropertyValue

addPropertyValue

addPropertyValue

getProperties

getPropertyDeletes

getPropertySoftDeletes

deleteProperty

deleteProperties

deleteProperties

deleteProperty

deleteProperty

softDeleteProperty

softDeleteProperties

softDeleteProperties

softDeleteProperty

softDeleteProperty

alterPropertyVisibility

alterPropertyVisibility

alterPropertyVisibility

alterElementVisibility

setPropertyMetadata

setPropertyMetadata

setPropertyMetadata

getElement

getNewElementVisibility

getAlterPropertyVisibilities

getSetPropertyMetadatas

getIndexHint

setIndexHint

hasChanges