org.gradoop.common.model.impl.pojo

Class Element

java.lang.Object

org.gradoop.common.model.impl.pojo.Element

All Implemented Interfaces:

Serializable, EPGMAttributed, EPGMElement, EPGMIdentifiable, EPGMLabeled

Direct Known Subclasses:

GraphElement, GraphHead

public abstract class Element
extends Object
implements EPGMElement

Abstract base class for graphs, vertices and edges.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected GradoopId	id Entity identifier.
protected String	label Label of that entity.
protected Properties	properties Internal property storage

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Element() Default constructor.
protected	Element(GradoopId id, String label, Properties properties) Creates an object from the given parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
GradoopId	getId() Returns the identifier of that entity.
String	getLabel() Returns the label of that entity.
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.
int	hashCode()
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	setId(GradoopId id) Sets the identifier of that entity.
void	setLabel(String label) Sets the label of that entity.
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.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

id

protected GradoopId id

Entity identifier.

label

protected String label

Label of that entity.

properties

protected Properties properties

Internal property storage

Constructor Detail

Element

protected Element()

Default constructor.

Element

protected Element(GradoopId id,
                  String label,
                  Properties properties)

Creates an object from the given parameters. Can only be called by inheriting classes.

Parameters:

id - entity identifier

label - entity label

properties - key-value properties

Method Detail

getId

public GradoopId getId()

Returns the identifier of that entity.

Specified by:

getId in interface EPGMIdentifiable

Returns:

identifier

setId

public void setId(GradoopId id)

Sets the identifier of that entity.

Specified by:

setId in interface EPGMIdentifiable

Parameters:

id - identifier

getLabel

public String getLabel()

Returns the label of that entity.

Specified by:

getLabel in interface EPGMLabeled

Returns:

label

setLabel

public void setLabel(String label)

Sets the label of that entity.

Specified by:

setLabel in interface EPGMLabeled

Parameters:

label - label to be set (must not be null or empty)

getProperties

@Nullable
public Properties getProperties()

Returns all properties of that entity.

Specified by:

getProperties in interface EPGMAttributed

Returns:

properties

getPropertyKeys

public Iterable<String> getPropertyKeys()

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

Specified by:

getPropertyKeys in interface EPGMAttributed

Returns:

property keys

getPropertyValue

public PropertyValue getPropertyValue(String key)

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

Specified by:

getPropertyValue in interface EPGMAttributed

Parameters:

key - property key

Returns:

property value or null if key does not exist

setProperties

public void setProperties(Properties properties)

Sets the given properties as new properties.

Specified by:

setProperties in interface EPGMAttributed

Parameters:

properties - new properties

setProperty

public 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.

Specified by:

setProperty in interface EPGMAttributed

Parameters:

property - property

setProperty

public 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.

Specified by:

setProperty in interface EPGMAttributed

Parameters:

key - property key

value - property value

setProperty

public 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.

Specified by:

setProperty in interface EPGMAttributed

Parameters:

key - property key

value - property value

removeProperty

public PropertyValue removeProperty(String key)

Removes the properties associated with the given key.

Specified by:

removeProperty in interface EPGMAttributed

Parameters:

key - property key

Returns:

associated property value or null if the key was not found

getPropertyCount

public int getPropertyCount()

Description copied from interface: EPGMAttributed

Returns the number of properties stored at that entity.

Specified by:

getPropertyCount in interface EPGMAttributed

Returns:

number or properties

hasProperty

public boolean hasProperty(String key)

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

Specified by:

hasProperty in interface EPGMAttributed

Parameters:

key - property key

Returns:

true, if element has property with given key

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object