com.objex.progeny.anywhere.enums
Enum RELATIONSHIP

java.lang.Object
  java.lang.Enum<RELATIONSHIP>
      com.objex.progeny.anywhere.enums.RELATIONSHIP

All Implemented Interfaces:

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

public enum RELATIONSHIP
extends java.lang.Enum<RELATIONSHIP>
implements java.io.Serializable

An enum of all relationship types involved in a pedigree

Enum Constant Summary

RELATIONSHIP_BROTHER
Brother relationship

RELATIONSHIP_DAUGHTER
Daughter relationship

RELATIONSHIP_FATHER
Father relationship

RELATIONSHIP_MOTHER
Mother relationship

RELATIONSHIP_SISTER
Sister relationship

RELATIONSHIP_SON
Son relationship

RELATIONSHIP_SPOUSE
Spousal relationship

RELATIONSHIP_TWINBROTHER
Twin brother relationship

RELATIONSHIP_TWINSISTER
Twin sister relationship

RELATIONSHIP_UNKNOWN
Unknown relationship

Method Summary

int	getType()
static RELATIONSHIP	valueOf(int ai_rel)
static RELATIONSHIP	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static RELATIONSHIP[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

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

Enum Constant Detail

RELATIONSHIP_MOTHER

public static final RELATIONSHIP RELATIONSHIP_MOTHER

Mother relationship

RELATIONSHIP_FATHER

public static final RELATIONSHIP RELATIONSHIP_FATHER

Father relationship

RELATIONSHIP_DAUGHTER

public static final RELATIONSHIP RELATIONSHIP_DAUGHTER

Daughter relationship

RELATIONSHIP_SON

public static final RELATIONSHIP RELATIONSHIP_SON

Son relationship

RELATIONSHIP_SISTER

public static final RELATIONSHIP RELATIONSHIP_SISTER

Sister relationship

RELATIONSHIP_BROTHER

public static final RELATIONSHIP RELATIONSHIP_BROTHER

Brother relationship

RELATIONSHIP_TWINSISTER

public static final RELATIONSHIP RELATIONSHIP_TWINSISTER

Twin sister relationship

RELATIONSHIP_TWINBROTHER

public static final RELATIONSHIP RELATIONSHIP_TWINBROTHER

Twin brother relationship

RELATIONSHIP_SPOUSE

public static final RELATIONSHIP RELATIONSHIP_SPOUSE

Spousal relationship

RELATIONSHIP_UNKNOWN

public static final RELATIONSHIP RELATIONSHIP_UNKNOWN

Unknown relationship

Method Detail

values

public static final RELATIONSHIP[] values()

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

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

Returns:

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

valueOf

public static RELATIONSHIP 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

getType

public int getType()

Returns:

The relationship ID

valueOf

public static RELATIONSHIP valueOf(int ai_rel)

Parameters:

ai_rel - The relationship ID

Returns:

The relationship Enum for the given relationship ID. Null may be returned if no Enum matches the ID