org.vertexium.Element Maven / Gradle / Ivy
package org.vertexium;
import com.google.common.collect.ImmutableSet;
import org.vertexium.mutation.ExistingElementMutation;
import org.vertexium.query.QueryableIterable;
import org.vertexium.util.FilterIterable;
import java.util.EnumSet;
/**
* An element on the graph. This can be either a vertex or edge.
*
* Elements also contain properties. These properties are unique given their key, name, and visibility.
* For example a property with key "key1" and name "age" could have to values, one with visibility "a" and one
* with visibility "b".
*/
public interface Element extends VertexiumObject {
/**
* Meta property name used for operations such as sorting
*/
String ID_PROPERTY_NAME = "__ID__";
/**
* id of the element.
*/
String getId();
/**
* the visibility of the element.
*/
Visibility getVisibility();
/**
* The timestamp of when this element was updated.
*/
long getTimestamp();
/**
* Gets all property values from all timestamps in descending timestamp order.
*/
default Iterable getHistoricalPropertyValues(Authorizations authorizations) {
return getHistoricalPropertyValues(null, null, authorizations);
}
/**
* Gets all property values from the given range of timestamps in descending timestamp order.
*/
default Iterable getHistoricalPropertyValues(final Long startTime, final Long endTime, Authorizations authorizations) {
return getHistoricalPropertyValues(null, null, null, startTime, endTime, authorizations);
}
/**
* Gets property values from all timestamps in descending timestamp order.
*
* @param key the key of the property.
* @param name the name of the property.
* @param visibility The visibility of the property to get.
*/
default Iterable getHistoricalPropertyValues(String key, String name, Visibility visibility, Authorizations authorizations) {
return getHistoricalPropertyValues(key, name, visibility, null, null, authorizations);
}
/**
* Gets property values from the given range of timestamps in descending timestamp order.
*
* @param key the key of the property.
* @param name the name of the property.
* @param visibility The visibility of the property to get.
*/
default Iterable getHistoricalPropertyValues(
String key,
String name,
Visibility visibility,
Long startTime,
Long endTime,
Authorizations authorizations
) {
return new FilterIterable(getHistoricalPropertyValues(key, name, visibility, authorizations)) {
@Override
protected boolean isIncluded(HistoricalPropertyValue pv) {
if (startTime != null && pv.getTimestamp() < startTime) {
return false;
}
if (endTime != null && pv.getTimestamp() > endTime) {
return false;
}
return true;
}
};
}
/**
* Prepares a mutation to allow changing multiple property values at the same time. This method is similar to
* Graph#prepareVertex(Visibility, Authorizations)
* in that it allows multiple properties to be changed and saved in a single mutation.
*
* @return The mutation builder.
*/
ExistingElementMutation prepareMutation();
/**
* Permanently deletes a property given it's key and name from the element. Only properties which you have access
* to can be deleted using this method.
*
* @param key The property key.
* @param name The property name.
*/
default void deleteProperty(String key, String name, Authorizations authorizations) {
deleteProperty(key, name, null, authorizations);
}
/**
* Permanently deletes a property given it's key and name from the element. Only properties which you have access
* to can be deleted using this method.
*
* @param key The property key.
* @param name The property name.
* @param visibility The property visibility.
*/
void deleteProperty(String key, String name, Visibility visibility, Authorizations authorizations);
/**
* Permanently deletes all properties with the given name that you have access to. Only properties which you have
* access to will be deleted.
*
* @param name The name of the property to delete.
*/
default void deleteProperties(String name, Authorizations authorizations) {
for (Property p : getProperties(name)) {
deleteProperty(p.getKey(), p.getName(), p.getVisibility(), authorizations);
}
}
/**
* Soft deletes a property given it's key and name from the element. Only properties which you have access
* to can be soft deleted using this method.
*
* @param key The property key.
* @param name The property name.
*/
default void softDeleteProperty(String key, String name, Authorizations authorizations) {
softDeleteProperty(key, name, null, authorizations);
}
/**
* Soft deletes a property given it's key and name from the element for a given visibility. Only properties which you have access
* to can be soft deleted using this method.
*
* @param key The property key.
* @param name The property name.
* @param visibility The visibility string of the property to soft delete.
*/
void softDeleteProperty(String key, String name, Visibility visibility, Authorizations authorizations);
/**
* Soft deletes all properties with the given name that you have access to. Only properties which you have
* access to will be soft deleted.
*
* @param name The name of the property to delete.
*/
default void softDeleteProperties(String name, Authorizations authorizations) {
for (Property property : getProperties(name)) {
softDeleteProperty(property.getKey(), property.getName(), property.getVisibility(), authorizations);
}
}
/**
* Gets the graph that this element belongs to.
*/
Graph getGraph();
/**
* Adds or updates a property.
*
* @param key The unique key given to the property allowing for multi-valued properties.
* @param name The name of the property.
* @param value The value of the property.
* @param visibility The visibility to give this property.
*/
default void addPropertyValue(String key, String name, Object value, Visibility visibility, Authorizations authorizations) {
prepareMutation().addPropertyValue(key, name, value, visibility).save(authorizations);
}
/**
* Adds or updates a property.
*
* @param key The unique key given to the property allowing for multi-valued properties.
* @param name The name of the property.
* @param value The value of the property.
* @param metadata The metadata to assign to this property.
* @param visibility The visibility to give this property.
*/
default void addPropertyValue(String key, String name, Object value, Metadata metadata, Visibility visibility, Authorizations authorizations) {
prepareMutation().addPropertyValue(key, name, value, metadata, visibility).save(authorizations);
}
/**
* 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.
*
* @param name The name of the property.
* @param value The value of the property.
* @param visibility The visibility to give this property.
*/
default void setProperty(String name, Object value, Visibility visibility, Authorizations authorizations) {
prepareMutation().setProperty(name, value, visibility).save(authorizations);
}
/**
* 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.
*
* @param name The name of the property.
* @param value The value of the property.
* @param metadata The metadata to assign to this property.
* @param visibility The visibility to give this property.
*/
default void setProperty(String name, Object value, Metadata metadata, Visibility visibility, Authorizations authorizations) {
prepareMutation().setProperty(name, value, metadata, visibility).save(authorizations);
}
/**
* Gets the authorizations used to get this element.
*/
Authorizations getAuthorizations();
/**
* Marks a property as hidden for a given visibility.
*
* @param key The key of the property.
* @param name The name of the property.
* @param propertyVisibility The visibility of the property.
* @param 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.
* @param authorizations The authorizations used.
*/
default void markPropertyHidden(String key, String name, Visibility propertyVisibility, Visibility visibility, Authorizations authorizations) {
markPropertyHidden(key, name, propertyVisibility, null, visibility, authorizations);
}
/**
* Marks a property as hidden for a given visibility.
*
* @param key The key of the property.
* @param name The name of the property.
* @param propertyVisibility The visibility of the property.
* @param timestamp The timestamp.
* @param 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.
* @param authorizations The authorizations used.
*/
default void markPropertyHidden(String key, String name, Visibility propertyVisibility, Long timestamp, Visibility visibility, Authorizations authorizations) {
Iterable properties = getProperties(key, name);
for (Property property : properties) {
if (property.getVisibility().equals(propertyVisibility)) {
markPropertyHidden(property, timestamp, visibility, authorizations);
return;
}
}
throw new IllegalArgumentException("Could not find property " + key + " : " + name + " : " + propertyVisibility);
}
/**
* Marks a property as hidden for a given visibility.
*
* @param property The property.
* @param 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.
* @param authorizations The authorizations used.
*/
default void markPropertyHidden(Property property, Visibility visibility, Authorizations authorizations) {
markPropertyHidden(property, null, visibility, authorizations);
}
/**
* Marks a property as hidden for a given visibility.
*
* @param property The property.
* @param timestamp The timestamp.
* @param 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.
* @param authorizations The authorizations used.
*/
void markPropertyHidden(Property property, Long timestamp, Visibility visibility, Authorizations authorizations);
/**
* Marks a property as visible for a given visibility, effectively undoing markPropertyHidden.
*
* @param key The key of the property.
* @param name The name of the property.
* @param propertyVisibility The visibility of the property.
* @param visibility The visibility string under which this property is now visible.
* @param authorizations The authorizations used.
*/
default void markPropertyVisible(String key, String name, Visibility propertyVisibility, Visibility visibility, Authorizations authorizations) {
markPropertyVisible(key, name, propertyVisibility, null, visibility, authorizations);
}
/**
* Marks a property as visible for a given visibility, effectively undoing markPropertyHidden.
*
* @param key The key of the property.
* @param name The name of the property.
* @param propertyVisibility The visibility of the property.
* @param timestamp The timestamp.
* @param visibility The visibility string under which this property is now visible.
* @param authorizations The authorizations used.
*/
default void markPropertyVisible(String key, String name, Visibility propertyVisibility, Long timestamp, Visibility visibility, Authorizations authorizations) {
Iterable properties = getProperties(key, name);
for (Property property : properties) {
if (property.getVisibility().equals(propertyVisibility)) {
markPropertyVisible(property, timestamp, visibility, authorizations);
return;
}
}
throw new IllegalArgumentException("Could not find property " + key + " : " + name + " : " + propertyVisibility);
}
/**
* Marks a property as visible for a given visibility, effectively undoing markPropertyHidden.
*
* @param property The property.
* @param visibility The visibility string under which this property is now visible.
* @param authorizations The authorizations used.
*/
default void markPropertyVisible(Property property, Visibility visibility, Authorizations authorizations) {
markPropertyVisible(property, null, visibility, authorizations);
}
/**
* Marks a property as visible for a given visibility, effectively undoing markPropertyHidden.
*
* @param property The property.
* @param timestamp The timestamp.
* @param visibility The visibility string under which this property is now visible.
* @param authorizations The authorizations used.
*/
void markPropertyVisible(Property property, Long timestamp, Visibility visibility, Authorizations authorizations);
/**
* Given the supplied authorizations is this element hidden?
*
* @param authorizations the authorizations to check against.
* @return true, if it would be hidden from those authorizations.
*/
default boolean isHidden(Authorizations authorizations) {
for (Visibility visibility : getHiddenVisibilities()) {
if (authorizations.canRead(visibility)) {
return true;
}
}
return false;
}
/**
* Gets the list of hidden visibilities
*/
Iterable getHiddenVisibilities();
/**
* Gets the list of extended data table names.
*/
ImmutableSet getExtendedDataTableNames();
/**
* Gets all the rows from an extended data table.
*
* @param tableName The name of the table to get rows from.
* @return Iterable of all the rows.
*/
QueryableIterable getExtendedData(String tableName);
/**
* Fetch hints used when fetching this element.
*/
EnumSet getFetchHints();
@Override
default int compareTo(Object o) {
if (getClass().isInstance(o)) {
return getId().compareTo(((Element) o).getId());
}
throw new ClassCastException("o must be an " + getClass().getName());
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy