org.chromattic.api
Enum RelationshipType

java.lang.Object
  java.lang.Enum<RelationshipType>
      org.chromattic.api.RelationshipType

All Implemented Interfaces:

Serializable, Comparable<RelationshipType>

public enum RelationshipType
extends Enum<RelationshipType>

The type of a relationship. It defines the semantics about how the relationship is maintained between nodes.

Version:

$Revision$

Author:

Julien Viet

See Also:

OneToMany, ManyToOne

Enum Constant Summary

HIERARCHIC
A hierarchic relationship uses the natural parent child relationship to associate nodes.

MIXIN
A mixin relationship use the mixin of a node type that are added / removed during the node type life cycle.

PATH
A path relationship uses path a typed property to associate nodes.

REFERENCE
A reference relationship uses reference a typed property to associate nodes.

Method Summary

static RelationshipType	valueOf(String name) Returns the enum constant of this type with the specified name.
static RelationshipType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HIERARCHIC

public static final RelationshipType HIERARCHIC

A hierarchic relationship uses the natural parent child relationship to associate nodes. It is valid either for one to one or one to many relationship.

REFERENCE

public static final RelationshipType REFERENCE

A reference relationship uses reference a typed property to associate nodes. It is only valid for one to many relationships.

PATH

public static final RelationshipType PATH

A path relationship uses path a typed property to associate nodes. It is only valid for one to many relationships.

MIXIN

public static final RelationshipType MIXIN

A mixin relationship use the mixin of a node type that are added / removed during the node type life cycle. It is only valid for one to one relationships.

Method Detail

values

public static RelationshipType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RelationshipType c : RelationshipType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RelationshipType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null