ElementBuilder (Vertexium: Core 4.3.0 API)

java.lang.Object
- org.vertexium.ElementBuilder<T>

All Implemented Interfaces:: ElementMutation<T>

Direct Known Subclasses:: EdgeBuilderBase, VertexBuilder

public abstract class ElementBuilder<T extends Element>
extends Object
implements ElementMutation<T>

Field Summary
- Fields inherited from interface org.vertexium.mutation.ElementMutation
  DEFAULT_KEY

Constructor Summary

Constructors
Modifier Constructor and Description

protected ElementBuilder(String elementId)

Constructors
Modifier	Constructor and Description
`protected`	`ElementBuilder(String elementId)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`ElementMutation<T>`	`addExtendedData(String tableName, String row, String column, Object value, Long timestamp, Visibility visibility)` Adds an extended data cell to the element.
`ElementBuilder<T>`	`addExtendedData(String tableName, String row, String column, Object value, Visibility visibility)` Adds an extended data cell to the element.
`ElementBuilder<T>`	`addExtendedData(String tableName, String row, String column, String key, Object value, Long timestamp, Visibility visibility)` Adds an extended data cell to the element.
`ElementBuilder<T>`	`addExtendedData(String tableName, String row, String column, String key, Object value, Visibility visibility)` Adds an extended data cell to the element.
`ElementBuilder<T>`	`addPropertyValue(String key, String name, Object value, Metadata metadata, Long timestamp, Visibility visibility)` Adds or updates a property.
`ElementBuilder<T>`	`addPropertyValue(String key, String name, Object value, Metadata metadata, Visibility visibility)` Adds or updates a property.
`ElementBuilder<T>`	`addPropertyValue(String key, String name, Object value, Visibility visibility)` Adds or updates a property.
`ElementBuilder<T>`	`deleteExtendedData(String tableName, String row, String column, String key, Visibility visibility)` Deletes an extended data cell from an element.
`ElementBuilder<T>`	`deleteExtendedData(String tableName, String row, String column, Visibility visibility)` Deletes an extended data cell from an element.
`ElementBuilder<T>`	`deleteProperty(Property property)` Deletes a property.
`ElementBuilder<T>`	`deleteProperty(String key, String name, Visibility visibility)` Deletes a property.
`ElementBuilder<T>`	`deleteProperty(String name, Visibility visibility)` Deletes the default property with that name.
`String`	`getElementId()`
`Iterable<ExtendedDataMutation>`	`getExtendedData()` Gets the extended data mutations.
`Iterable<ExtendedDataDeleteMutation>`	`getExtendedDataDeletes()` Gets the extended data columns currently being deleted in this mutation
`com.google.common.collect.ImmutableSet<String>`	`getExtendedDataTableNames()`
`IndexHint`	`getIndexHint()` Gets the currently set index hint.
`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.
`boolean`	`hasChanges()` true, if this mutation has any changes.
`abstract T`	`save(Authorizations authorizations)` saves the element to the graph.
`ElementMutation<T>`	`setIndexHint(IndexHint indexHint)` Sets the index hint of this element.
`ElementBuilder<T>`	`setProperty(String name, Object value, Metadata metadata, Visibility visibility)` Sets or updates a property value.
`ElementBuilder<T>`	`setProperty(String name, Object value, Visibility visibility)` Sets or updates a property value.
`ElementBuilder<T>`	`softDeleteProperty(Property property)` Soft deletes a property.
`ElementBuilder<T>`	`softDeleteProperty(String key, String name, Visibility visibility)` Soft deletes a property.
`ElementBuilder<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
  - ElementBuilder
```
protected ElementBuilder(String elementId)
```
- Method Detail
  - getElementId
```
public String getElementId()
```
  - setProperty
```
public ElementBuilder<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.
    The added property will also be indexed in the configured search provider. The type of the value will determine how it gets indexed.
    
    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 ElementBuilder<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.
    The added property will also be indexed in the configured search provider. The type of the value will determine how it gets indexed.
    
    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 ElementBuilder<T> addPropertyValue(String key,
                                          String name,
                                          Object value,
                                          Visibility visibility)
```
    Adds or updates a property.
    The added property will also be indexed in the configured search provider. The type of the value will determine how it gets indexed.
    
    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 ElementBuilder<T> addPropertyValue(String key,
                                          String name,
                                          Object value,
                                          Metadata metadata,
                                          Visibility visibility)
```
    Adds or updates a property.
    The added property will also be indexed in the configured search provider. The type of the value will determine how it gets indexed.
    
    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 ElementBuilder<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.
  - deleteProperty
```
public ElementBuilder<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.
  - deleteProperty
```
public ElementBuilder<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 ElementBuilder<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 ElementBuilder<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.
  - softDeleteProperty
```
public ElementBuilder<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 ElementBuilder<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.
  - addExtendedData
```
public ElementBuilder<T> addExtendedData(String tableName,
                                         String row,
                                         String column,
                                         Object value,
                                         Visibility visibility)
```
    Description copied from interface: ElementMutation
    
    Adds an extended data cell to the element.
    
    Specified by:
    
    addExtendedData in interface ElementMutation<T extends Element>
    
    Parameters:
    
    tableName - The extended data table to add the cell to.
    
    row - The row to add the cell to.
    
    column - The column name.
    
    value - The cell value.
    
    visibility - The visibility of the value.
  - addExtendedData
```
public ElementMutation<T> addExtendedData(String tableName,
                                          String row,
                                          String column,
                                          Object value,
                                          Long timestamp,
                                          Visibility visibility)
```
    Description copied from interface: ElementMutation
    
    Adds an extended data cell to the element.
    
    Specified by:
    
    addExtendedData in interface ElementMutation<T extends Element>
    
    Parameters:
    
    tableName - The extended data table to add the cell to.
    
    row - The row to add the cell to.
    
    column - The column name.
    
    value - The cell value.
    
    timestamp - The timestamp of the value. null, to automatically generate one.
    
    visibility - The visibility of the value.
  - addExtendedData
```
public ElementBuilder<T> addExtendedData(String tableName,
                                         String row,
                                         String column,
                                         String key,
                                         Object value,
                                         Visibility visibility)
```
    Description copied from interface: ElementMutation
    
    Adds an extended data cell to the element.
    
    Specified by:
    
    addExtendedData in interface ElementMutation<T extends Element>
    
    Parameters:
    
    tableName - The extended data table to add the cell to.
    
    row - The row to add the cell to.
    
    column - The column name.
    
    key - The column multi-value key.
    
    value - The cell value.
    
    visibility - The visibility of the value.
  - addExtendedData
```
public ElementBuilder<T> addExtendedData(String tableName,
                                         String row,
                                         String column,
                                         String key,
                                         Object value,
                                         Long timestamp,
                                         Visibility visibility)
```
    Description copied from interface: ElementMutation
    
    Adds an extended data cell to the element.
    
    Specified by:
    
    addExtendedData in interface ElementMutation<T extends Element>
    
    Parameters:
    
    tableName - The extended data table to add the cell to.
    
    row - The row to add the cell to.
    
    column - The column name.
    
    key - The column multi-value key.
    
    value - The cell value.
    
    timestamp - The timestamp of the value. null, to automatically generate one.
    
    visibility - The visibility of the value.
  - deleteExtendedData
```
public ElementBuilder<T> deleteExtendedData(String tableName,
                                            String row,
                                            String column,
                                            Visibility visibility)
```
    Description copied from interface: ElementMutation
    
    Deletes an extended data cell from an element.
    
    Specified by:
    
    deleteExtendedData in interface ElementMutation<T extends Element>
    
    Parameters:
    
    tableName - The extended data table to add the cell to.
    
    row - The row to add the cell to.
    
    column - The column name.
    
    visibility - The visibility of the value.
  - deleteExtendedData
```
public ElementBuilder<T> deleteExtendedData(String tableName,
                                            String row,
                                            String column,
                                            String key,
                                            Visibility visibility)
```
    Description copied from interface: ElementMutation
    
    Deletes an extended data cell from an element.
    
    Specified by:
    
    deleteExtendedData in interface ElementMutation<T extends Element>
    
    Parameters:
    
    tableName - The extended data table to add the cell to.
    
    row - The row to add the cell to.
    
    column - The column name.
    
    key - The column multi-value key.
    
    visibility - The visibility of the value.
  - save
```
public abstract T save(Authorizations authorizations)
```
    saves the element to the graph.
    
    Specified by:
    
    save in interface ElementMutation<T extends Element>
    
    Returns:
    
    either the vertex or edge just saved.
  - 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>
  - getExtendedData
```
public Iterable<ExtendedDataMutation> getExtendedData()
```
    Description copied from interface: ElementMutation
    
    Gets the extended data mutations.
    
    Specified by:
    
    getExtendedData in interface ElementMutation<T extends Element>
  - getExtendedDataDeletes
```
public Iterable<ExtendedDataDeleteMutation> getExtendedDataDeletes()
```
    Description copied from interface: ElementMutation
    
    Gets the extended data columns currently being deleted in this mutation
    
    Specified by:
    
    getExtendedDataDeletes in interface ElementMutation<T extends Element>
  - getIndexHint
```
public IndexHint getIndexHint()
```
    Description copied from interface: ElementMutation
    
    Gets the currently set index hint.
    
    Specified by:
    
    getIndexHint in interface ElementMutation<T extends Element>
  - getExtendedDataTableNames
```
public com.google.common.collect.ImmutableSet<String> getExtendedDataTableNames()
```
  - 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 ElementBuilder<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

ElementBuilder

Method Detail

getElementId

setProperty

setProperty

addPropertyValue

addPropertyValue

addPropertyValue

deleteProperty

deleteProperty

deleteProperty

softDeleteProperty

softDeleteProperty

softDeleteProperty

addExtendedData

addExtendedData

addExtendedData

addExtendedData

deleteExtendedData

deleteExtendedData

save

getProperties

getPropertyDeletes

getPropertySoftDeletes

getExtendedData

getExtendedDataDeletes

getIndexHint

getExtendedDataTableNames

setIndexHint

hasChanges