org.chromattic.api
Enum RelationshipType

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RelationshipType>

public enum RelationshipType
extends java.lang.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

EMBEDDED
An embedded relationship defines a relationship between two types that are have a relationship between their node types.

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

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(java.lang.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.

EMBEDDED

public static final RelationshipType EMBEDDED

An embedded relationship defines a relationship between two types that are have a relationship between their node types.

The owner side of the relationship must be a primary node type, the owned side of the relationship can be any node type. Embedded relationship only exist for OneToOne relationships

When the owned side is a primary node type, the owned node type must be super node type of the owner node type. The relationship is thereby statically defined.

When the owned side is a mixin type, the relationship exists when the owner side has the mixin of the owned side. The relationship is static when the owner node type defines the owned mixin type has a super node type directly or indirectly. The relationship is dynamic when the owner node type does not define the owned mixin type has a super node type directly and indirectly, therefore the relationship can be created or destroyed at runtime.

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(java.lang.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:

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

java.lang.NullPointerException - if the argument is null