org.gradoop.common.model.api.entities

Interface EPGMAttributed

All Known Subinterfaces:

EPGMEdge, EPGMElement, EPGMGraphElement, EPGMGraphHead, EPGMVertex

All Known Implementing Classes:

Edge, Element, GraphElement, GraphHead, Vertex

public interface EPGMAttributed

Used to describe entities that can have properties.

Method Summary

Modifier and Type	Method and Description
Properties	getProperties() Returns all properties of that entity.
int	getPropertyCount() Returns the number of properties stored at that entity.
Iterable<String>	getPropertyKeys() Returns all property keys of that entity or null it that entity has no properties.
PropertyValue	getPropertyValue(String key) Returns the object referenced by the given key or null if the key does not exist.
boolean	hasProperty(String key) Returns true, if the element has a property with the given property key.
PropertyValue	removeProperty(String key) Removes the properties associated with the given key.
void	setProperties(Properties properties) Sets the given properties as new properties.
void	setProperty(Property property) Adds a given property to that entity.
void	setProperty(String key, Object value) Adds a given property to that entity.
void	setProperty(String key, PropertyValue value) Adds a given property to that entity.

Method Detail

getProperties

@Nullable
Properties getProperties()

Returns all properties of that entity.

Returns:

properties

getPropertyKeys

Iterable<String> getPropertyKeys()

Returns all property keys of that entity or null it that entity has no properties.

Returns:

property keys

getPropertyValue

PropertyValue getPropertyValue(String key)

Returns the object referenced by the given key or null if the key does not exist.

Parameters:

key - property key

Returns:

property value or null if key does not exist

setProperties

void setProperties(Properties properties)

Sets the given properties as new properties.

Parameters:

properties - new properties

setProperty

void setProperty(Property property)

Adds a given property to that entity. If a property with the same key does not exist, a new property will be created. Otherwise, the existing property value will be overwritten by the given value.

Parameters:

property - property

setProperty

void setProperty(String key,
                 PropertyValue value)

Adds a given property to that entity. If key does not exist, a new property will be created. Otherwise, the existing property value will be overwritten by the given value.

Parameters:

key - property key

value - property value

setProperty

void setProperty(String key,
                 Object value)

Adds a given property to that entity. If key does not exist, a new property will be created. Otherwise, the existing property value will be overwritten by the given value.

Parameters:

key - property key

value - property value

removeProperty

PropertyValue removeProperty(String key)

Removes the properties associated with the given key.

Parameters:

key - property key

Returns:

associated property value or null if the key was not found

getPropertyCount

int getPropertyCount()

Returns the number of properties stored at that entity.

Returns:

number or properties

hasProperty

boolean hasProperty(String key)

Returns true, if the element has a property with the given property key.

Parameters:

key - property key

Returns:

true, if element has property with given key