fr.inria.atlanmod.neoemf.data.structure

Class FeatureKey

java.lang.Object

fr.inria.atlanmod.neoemf.data.structure.FeatureKey

All Implemented Interfaces:

Serializable, Comparable<FeatureKey>

Direct Known Subclasses:

HBaseFeatureKey, MultivaluedFeatureKey

public class FeatureKey
extends Object
implements Comparable<FeatureKey>, Serializable

A simple representation of a EStructuralFeature of a PersistentEObject.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FeatureKey(Id id, String name) Constructs a new FeatureKey with the given id and the given name, which are used as a simple representation of a feature of an object.

Method Summary

Modifier and Type	Method and Description
int	compareTo(FeatureKey o)
boolean	equals(Object o)
static FeatureKey	from(InternalEObject internalObject, EStructuralFeature feature) Creates a new FeatureKey from the given internalObject and the given feature.
static FeatureKey	from(PersistentEObject object, EStructuralFeature feature) Creates a new FeatureKey from the given object and the given feature.
int	hashCode()
Id	id() Returns the identifier of the PersistentEObject.
String	name() Returns the name of the EStructuralFeature of the PersistentEObject.
static FeatureKey	of(Id id, String name) Creates a new FeatureKey with the given id and the given name, which are used as a simple representation of a feature of an object.
String	toString()
MultivaluedFeatureKey	withPosition(int position) Creates a new MultivaluedFeatureKey with the Id and the name of this FeatureKey, and adding the given position.

Methods inherited from class java.lang.Object

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

Constructor Detail

FeatureKey

protected FeatureKey(@Nonnull
                     Id id,
                     @Nonnull
                     String name)

Constructs a new FeatureKey with the given id and the given name, which are used as a simple representation of a feature of an object.

Parameters:

id - the identifier of the PersistentEObject

name - the name of the EStructuralFeature of the PersistentEObject

Method Detail

from

@Nonnull
public static FeatureKey from(@Nonnull
                                        InternalEObject internalObject,
                                        @Nonnull
                                        EStructuralFeature feature)

Creates a new FeatureKey from the given internalObject and the given feature.

This method behaves like: from(PersistentEObject.from(internalObject), feature).

Parameters:

internalObject - the InternalEObject that will be adapted as PersistentEObject

feature - the EStructuralFeature of the PersistentEObject

Returns:

a new FeatureKey

See Also:

from(PersistentEObject, EStructuralFeature), PersistentEObject.from(Object), ENamedElement.getName()

from

@Nonnull
public static FeatureKey from(@Nonnull
                                        PersistentEObject object,
                                        @Nonnull
                                        EStructuralFeature feature)

Creates a new FeatureKey from the given object and the given feature.

This method behaves like: of(object.id(), feature.getName()).

Parameters:

object - the PersistentEObject

feature - the EStructuralFeature of the PersistentEObject

Returns:

a new FeatureKey

See Also:

of(Id, String), PersistentEObject.id(), ENamedElement.getName()

of

@Nonnull
public static FeatureKey of(@Nonnull
                                      Id id,
                                      @Nonnull
                                      String name)

Creates a new FeatureKey with the given id and the given name, which are used as a simple representation of a feature of an object.

Parameters:

id - the identifier of the PersistentEObject

name - the name of the EStructuralFeature of the PersistentEObject

Returns:

a new FeatureKey

id

@Nonnull
public Id id()

Returns the identifier of the PersistentEObject.

Returns:

the identifier of the object

name

@Nonnull
public String name()

Returns the name of the EStructuralFeature of the PersistentEObject.

Returns:

the name of the feature

withPosition

@Nonnull
public MultivaluedFeatureKey withPosition(@Nonnegative
                                                    int position)

Creates a new MultivaluedFeatureKey with the Id and the name of this FeatureKey, and adding the given position.

Parameters:

position - the position of the EStructuralFeature

Returns:

a new MultivaluedFeatureKey

See Also:

of(Id, String)

compareTo

public int compareTo(@Nonnull
                     FeatureKey o)

Specified by:

compareTo in interface Comparable<FeatureKey>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object