uk.gov.gchq.gaffer.data.element

Class Element

java.lang.Object

uk.gov.gchq.gaffer.data.element.Element

All Implemented Interfaces:

Serializable, ElementId

Direct Known Subclasses:

Edge, Entity

public abstract class Element
extends Object
implements ElementId

Elements are the fundamental building blocks of the Graph. Elements should have identifier(s), an group and an optional collection of properties. Elements are designed so that multiple elements can share the same identifier(s) but are distinguished via their group.

• An group is a way of categorising the element and grouping elements together that share the same set of properties.
• The identifier(s) along with the group should uniquely identify an element.
• The properties are any other properties of the element. Properties should be split out as much as possible into simple properties, enabling validation, aggregation, transformation and filtering to be done more precisely.

Equals has been overridden to check groups are equal. NOTE - it does not compare property values.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface uk.gov.gchq.gaffer.data.element.id.ElementId

ElementId.Matches

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_GROUP

Method Summary

Modifier and Type	Method and Description
void	copyProperties(Properties properties)
abstract Element	emptyClone()
boolean	equals(Object obj)
Element	getElement()
String	getGroup()
abstract Object	getIdentifier(IdentifierType identifierType)
Properties	getProperties()
Object	getProperty(String name)
int	hashCode()
void	putProperty(String name, Object value)
Object	removeProperty(String propName)
Element	shallowClone()
boolean	shallowEquals(Element element)
boolean	shallowEquals(Object obj)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface uk.gov.gchq.gaffer.data.element.id.ElementId

getClassName, isEqual, isRelated, setClassName

Field Detail

DEFAULT_GROUP

public static final String DEFAULT_GROUP

See Also:

Constant Field Values

Method Detail

putProperty

public void putProperty(String name,
                        Object value)

copyProperties

public void copyProperties(Properties properties)

getProperty

public Object getProperty(String name)

getProperties

public Properties getProperties()

removeProperty

public Object removeProperty(String propName)

getGroup

public String getGroup()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

shallowEquals

public boolean shallowEquals(Object obj)

shallowEquals

public boolean shallowEquals(Element element)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

emptyClone

public abstract Element emptyClone()

shallowClone

public Element shallowClone()

getIdentifier

public abstract Object getIdentifier(IdentifierType identifierType)

getElement

public Element getElement()