com.mware.ge

Interface GeObject

All Superinterfaces:

Comparable

All Known Subinterfaces:

Edge, Element, ExtendedDataRow, Vertex

All Known Implementing Classes:

ElementBase, ExtendedDataRowBase, InMemoryEdge, InMemoryElement, InMemoryExtendedDataRow, InMemoryVertex, StorableEdge, StorableElement, StorableExtendedDataRow, StorableVertex

public interface GeObject
extends Comparable

Method Summary

Modifier and Type	Method and Description
Object	getId() Id of the object
Iterable<Property>	getProperties() an Iterable of all the properties on this element that you have access to based on the authorizations used to retrieve the element.
Iterable<Property>	getProperties(String name) an Iterable of all the properties with the given name on this element that you have access to based on the authorizations used to retrieve the element.
Iterable<Property>	getProperties(String key, String name) an Iterable of all the properties with the given name and key on this element that you have access to based on the authorizations used to retrieve the element.
default Property	getProperty(String name) Gets a property by name.
default Property	getProperty(String key, String name) Gets a property by key and name.
Property	getProperty(String key, String name, Visibility visibility) Gets a property by key, name, and visibility.
Property	getProperty(String name, Visibility visibility) Gets a property by name, and visibility.
default Value	getPropertyValue(String name) Convenience method to retrieve the first value of the property with the given name.
default Value	getPropertyValue(String name, int index) Gets the nth property value of the named property.
default Value	getPropertyValue(String key, String name) Convenience method to retrieve the first value of the property with the given name.
default Value	getPropertyValue(String key, String name, int index) Gets the nth property value of the named property.
default Iterable<Value>	getPropertyValues(String name) an Iterable of all the property values with the given name on this element that you have access to based on the authorizations used to retrieve the element.
default Iterable<Value>	getPropertyValues(String key, String name) an Iterable of all the property values with the given name and key on this element that you have access to based on the authorizations used to retrieve the element.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getId

Object getId()

Id of the object

getProperties

Iterable<Property> getProperties()

an Iterable of all the properties on this element that you have access to based on the authorizations used to retrieve the element.

getProperty

default Property getProperty(String name)

Gets a property by name. This assumes a single valued property. If multiple property values exists this will only return the first one.

Parameters:

name - the name of the property.

Returns:

The property if found. null, if not found.

getPropertyValue

default Value getPropertyValue(String name)

Convenience method to retrieve the first value of the property with the given name. This method calls Element#getPropertyValue(java.lang.String, int) with an index of 0.

This method makes no attempt to verify that one and only one value exists given the name.

Parameters:

name - The name of the property to retrieve

Returns:

The value of the property. null, if the property was not found.

getProperty

default Property getProperty(String key,
                             String name)

Gets a property by key and name.

Parameters:

key - the key of the property.

name - the name of the property.

Returns:

The property if found. null, if not found.

getProperty

Property getProperty(String key,
                     String name,
                     Visibility visibility)

Gets a property by key, name, and visibility.

Parameters:

key - the key of the property.

name - the name of the property.

visibility - The visibility of the property to get.

Returns:

The property if found. null, if not found.

getProperty

Property getProperty(String name,
                     Visibility visibility)

Gets a property by name, and visibility.

Parameters:

name - the name of the property.

visibility - The visibility of the property to get.

Returns:

The property if found. null, if not found.

getProperties

Iterable<Property> getProperties(String name)

an Iterable of all the properties with the given name on this element that you have access to based on the authorizations used to retrieve the element.

Parameters:

name - The name of the property to retrieve

getProperties

Iterable<Property> getProperties(String key,
                                 String name)

an Iterable of all the properties with the given name and key on this element that you have access to based on the authorizations used to retrieve the element.

Parameters:

key - The property key

name - The name of the property to retrieve

getPropertyValues

default Iterable<Value> getPropertyValues(String name)

an Iterable of all the property values with the given name on this element that you have access to based on the authorizations used to retrieve the element.

Parameters:

name - The name of the property to retrieve

getPropertyValues

default Iterable<Value> getPropertyValues(String key,
                                          String name)

an Iterable of all the property values with the given name and key on this element that you have access to based on the authorizations used to retrieve the element.

Parameters:

key - The property key

name - The name of the property to retrieve

getPropertyValue

default Value getPropertyValue(String key,
                               String name)

Convenience method to retrieve the first value of the property with the given name. This method calls Element#getPropertyValue(java.lang.String, java.lang.String, int) with an index of 0.

This method makes no attempt to verify that one and only one value exists given the name.

Parameters:

key - The key of the property

name - The name of the property to retrieve

Returns:

The value of the property. null, if the property was not found.

getPropertyValue

default Value getPropertyValue(String name,
                               int index)

Gets the nth property value of the named property. If the named property has multiple values this method provides an easy way to get the value by index.

This method is a convenience method and calls Element#getPropertyValues(java.lang.String) and iterates over that list until the nth value.

This method assumes the property values are retrieved in a deterministic order.

Parameters:

name - The name of the property to retrieve.

index - The zero based index into the values.

Returns:

The value of the property. null, if the property doesn't exist or doesn't have that many values.

getPropertyValue

default Value getPropertyValue(String key,
                               String name,
                               int index)

Gets the nth property value of the named property. If the named property has multiple values this method provides an easy way to get the value by index.

This method is a convenience method and calls Element#getPropertyValues(java.lang.String, java.lang.String) and iterates over that list until the nth value.

This method assumes the property values are retrieved in a deterministic order.

Parameters:

key - The property key

name - The name of the property to retrieve.

index - The zero based index into the values.

Returns:

The value of the property. null, if the property doesn't exist or doesn't have that many values.