public interface Element extends GeObject, ElementLocation
| Modifier and Type | Field and Description |
|---|---|
static String |
ID_PROPERTY_NAME
Meta property name used for operations such as sorting
|
| Modifier and Type | Method and Description |
|---|---|
default void |
addPropertyValue(String key,
String name,
Value value,
Metadata metadata,
Visibility visibility,
Authorizations authorizations)
Adds or updates a property.
|
default void |
addPropertyValue(String key,
String name,
Value value,
Visibility visibility,
Authorizations authorizations)
Adds or updates a property.
|
default int |
compareTo(Object o) |
default void |
deleteProperties(String name,
Authorizations authorizations)
Permanently deletes all properties with the given name that you have access to.
|
default void |
deleteProperty(Property property,
Authorizations authorizations)
Permanently deletes a property from the element.
|
default void |
deleteProperty(String key,
String name,
Authorizations authorizations)
Permanently deletes a property given it's key and name from the element.
|
void |
deleteProperty(String key,
String name,
Visibility visibility,
Authorizations authorizations)
Permanently deletes a property given it's key and name from the element.
|
Authorizations |
getAuthorizations()
Gets the authorizations used to get this element.
|
default Long |
getEndTime() |
default QueryableIterable<ExtendedDataRow> |
getExtendedData()
Gets all the rows from all the extended data tables.
|
default QueryableIterable<ExtendedDataRow> |
getExtendedData(FetchHints fetchHints)
Gets all the rows from all the extended data tables.
|
default QueryableIterable<ExtendedDataRow> |
getExtendedData(String tableName)
Gets all the rows from an extended data table.
|
QueryableIterable<ExtendedDataRow> |
getExtendedData(String tableName,
FetchHints fetchHints)
Gets all the rows from an extended data table.
|
com.google.common.collect.ImmutableSet<String> |
getExtendedDataTableNames()
Gets the extended data table names.
|
FetchHints |
getFetchHints()
Fetch hints used when fetching this element.
|
Graph |
getGraph()
Gets the graph that this element belongs to.
|
Iterable<Visibility> |
getHiddenVisibilities()
Gets the list of hidden visibilities
|
default Iterable<HistoricalPropertyValue> |
getHistoricalPropertyValues(Authorizations authorizations)
Gets all property values from all timestamps in descending timestamp order.
|
default Iterable<HistoricalPropertyValue> |
getHistoricalPropertyValues(Long startTime,
Long endTime,
Authorizations authorizations)
Gets all property values from the given range of timestamps in descending timestamp order.
|
default Iterable<HistoricalPropertyValue> |
getHistoricalPropertyValues(String key,
String name,
Visibility visibility,
Authorizations authorizations)
Gets property values from all timestamps in descending timestamp order.
|
default Iterable<HistoricalPropertyValue> |
getHistoricalPropertyValues(String key,
String name,
Visibility visibility,
Long startTime,
Long endTime,
Authorizations authorizations)
Gets property values from the given range of timestamps in descending timestamp order.
|
long |
getTimestamp()
The timestamp of when this element was updated.
|
Visibility |
getVisibility()
the visibility of the element.
|
default boolean |
isHidden(Authorizations authorizations)
Given the supplied authorizations is this element hidden?
|
void |
markPropertyHidden(Property property,
Long timestamp,
Visibility visibility,
Authorizations authorizations)
Marks a property as hidden for a given visibility.
|
default void |
markPropertyHidden(Property property,
Visibility visibility,
Authorizations authorizations)
Marks a property as hidden for a given visibility.
|
default void |
markPropertyHidden(String key,
String name,
Visibility propertyVisibility,
Long timestamp,
Visibility visibility,
Authorizations authorizations)
Marks a property as hidden for a given visibility.
|
default void |
markPropertyHidden(String key,
String name,
Visibility propertyVisibility,
Visibility visibility,
Authorizations authorizations)
Marks a property as hidden for a given visibility.
|
void |
markPropertyVisible(Property property,
Long timestamp,
Visibility visibility,
Authorizations authorizations)
Marks a property as visible for a given visibility, effectively undoing markPropertyHidden.
|
default void |
markPropertyVisible(Property property,
Visibility visibility,
Authorizations authorizations)
Marks a property as visible for a given visibility, effectively undoing markPropertyHidden.
|
default void |
markPropertyVisible(String key,
String name,
Visibility propertyVisibility,
Long timestamp,
Visibility visibility,
Authorizations authorizations)
Marks a property as visible for a given visibility, effectively undoing markPropertyHidden.
|
default void |
markPropertyVisible(String key,
String name,
Visibility propertyVisibility,
Visibility visibility,
Authorizations authorizations)
Marks a property as visible for a given visibility, effectively undoing markPropertyHidden.
|
<T extends Element> |
prepareMutation()
Prepares a mutation to allow changing multiple property values at the same time.
|
default void |
setProperty(String name,
Value value,
Metadata metadata,
Visibility visibility,
Authorizations authorizations)
Sets or updates a property value.
|
default void |
setProperty(String name,
Value value,
Visibility visibility,
Authorizations authorizations)
Sets or updates a property value.
|
default void |
softDeleteProperties(String name,
Authorizations authorizations)
Soft deletes all properties with the given name that you have access to.
|
default void |
softDeleteProperty(String key,
String name,
Authorizations authorizations)
Soft deletes a property given it's key and name from the element.
|
void |
softDeleteProperty(String key,
String name,
Visibility visibility,
Authorizations authorizations)
Soft deletes a property given it's key and name from the element for a given visibility.
|
getId, getProperties, getProperties, getProperties, getProperty, getProperty, getProperty, getProperty, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValues, getPropertyValuesedge, vertexstatic final String ID_PROPERTY_NAME
Visibility getVisibility()
getVisibility in interface ElementLocationlong getTimestamp()
default Long getEndTime()
default Iterable<HistoricalPropertyValue> getHistoricalPropertyValues(Authorizations authorizations)
default Iterable<HistoricalPropertyValue> getHistoricalPropertyValues(Long startTime, Long endTime, Authorizations authorizations)
default Iterable<HistoricalPropertyValue> getHistoricalPropertyValues(String key, String name, Visibility visibility, Authorizations authorizations)
key - the key of the property.name - the name of the property.visibility - The visibility of the property to get.default Iterable<HistoricalPropertyValue> getHistoricalPropertyValues(String key, String name, Visibility visibility, Long startTime, Long endTime, Authorizations authorizations)
key - the key of the property.name - the name of the property.visibility - The visibility of the property to get.<T extends Element> ExistingElementMutation<T> prepareMutation()
default void deleteProperty(Property property, Authorizations authorizations)
property - The property to delete.default void deleteProperty(String key, String name, Authorizations authorizations)
key - The property key.name - The property name.void deleteProperty(String key, String name, Visibility visibility, Authorizations authorizations)
key - The property key.name - The property name.visibility - The property visibility.default void deleteProperties(String name, Authorizations authorizations)
name - The name of the property to delete.default void softDeleteProperty(String key, String name, Authorizations authorizations)
key - The property key.name - The property name.void softDeleteProperty(String key, String name, Visibility visibility, Authorizations authorizations)
key - The property key.name - The property name.visibility - The visibility string of the property to soft delete.default void softDeleteProperties(String name, Authorizations authorizations)
name - The name of the property to delete.Graph getGraph()
default void addPropertyValue(String key, String name, Value value, Visibility visibility, Authorizations authorizations)
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.default void addPropertyValue(String key, String name, Value value, Metadata metadata, Visibility visibility, Authorizations authorizations)
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.default void setProperty(String name, Value value, Visibility visibility, Authorizations authorizations)
name - The name of the property.value - The value of the property.visibility - The visibility to give this property.default void setProperty(String name, Value value, Metadata metadata, Visibility visibility, Authorizations authorizations)
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.Authorizations getAuthorizations()
default void markPropertyHidden(String key, String name, Visibility propertyVisibility, Visibility visibility, Authorizations authorizations)
key - The key of the property.name - The name of the property.propertyVisibility - The visibility of the property.visibility - The visibility string under which this property is hidden.
This visibility can be a superset of the property visibility to mark
it as hidden for only a subset of authorizations.authorizations - The authorizations used.default void markPropertyHidden(String key, String name, Visibility propertyVisibility, Long timestamp, Visibility visibility, Authorizations authorizations)
key - The key of the property.name - The name of the property.propertyVisibility - The visibility of the property.timestamp - The timestamp.visibility - The visibility string under which this property is hidden.
This visibility can be a superset of the property visibility to mark
it as hidden for only a subset of authorizations.authorizations - The authorizations used.default void markPropertyHidden(Property property, Visibility visibility, Authorizations authorizations)
property - The property.visibility - The visibility string under which this property is hidden.
This visibility can be a superset of the property visibility to mark
it as hidden for only a subset of authorizations.authorizations - The authorizations used.void markPropertyHidden(Property property, Long timestamp, Visibility visibility, Authorizations authorizations)
property - The property.timestamp - The timestamp.visibility - The visibility string under which this property is hidden.
This visibility can be a superset of the property visibility to mark
it as hidden for only a subset of authorizations.authorizations - The authorizations used.default void markPropertyVisible(String key, String name, Visibility propertyVisibility, Visibility visibility, Authorizations authorizations)
key - The key of the property.name - The name of the property.propertyVisibility - The visibility of the property.visibility - The visibility string under which this property is now visible.authorizations - The authorizations used.default void markPropertyVisible(String key, String name, Visibility propertyVisibility, Long timestamp, Visibility visibility, Authorizations authorizations)
key - The key of the property.name - The name of the property.propertyVisibility - The visibility of the property.timestamp - The timestamp.visibility - The visibility string under which this property is now visible.authorizations - The authorizations used.default void markPropertyVisible(Property property, Visibility visibility, Authorizations authorizations)
property - The property.visibility - The visibility string under which this property is now visible.authorizations - The authorizations used.void markPropertyVisible(Property property, Long timestamp, Visibility visibility, Authorizations authorizations)
property - The property.timestamp - The timestamp.visibility - The visibility string under which this property is now visible.authorizations - The authorizations used.default boolean isHidden(Authorizations authorizations)
authorizations - the authorizations to check against.Iterable<Visibility> getHiddenVisibilities()
com.google.common.collect.ImmutableSet<String> getExtendedDataTableNames()
default QueryableIterable<ExtendedDataRow> getExtendedData(String tableName)
tableName - The name of the table to get rows from.QueryableIterable<ExtendedDataRow> getExtendedData(String tableName, FetchHints fetchHints)
tableName - The name of the table to get rows from.default QueryableIterable<ExtendedDataRow> getExtendedData()
default QueryableIterable<ExtendedDataRow> getExtendedData(FetchHints fetchHints)
fetchHints - Fetch hints to filter extended data rowsFetchHints getFetchHints()
default int compareTo(Object o)
compareTo in interface ComparableCopyright © 2016–2021 MWARE SOLUTIONS. All rights reserved.