com.ihr.xbrl.om.formula.functions

Enum XFI_concept_relationships.Axis

java.lang.Object

java.lang.Enum<XFI_concept_relationships.Axis>

com.ihr.xbrl.om.formula.functions.XFI_concept_relationships.Axis

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<XFI_concept_relationships.Axis>

Enclosing class:

XFI_concept_relationships

public static enum XFI_concept_relationships.Axis
extends java.lang.Enum<XFI_concept_relationships.Axis>

The Enum Axis.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ancestor The ancestor.
child The child.
descendant The descendant.
parent The parent.
sibling The sibling.
siblingOrDescendant The sibling or descendant.

Method Summary

Modifier and Type	Method and Description
static XFI_concept_relationships.Axis	fromString(java.lang.String text) From string.
java.lang.String	getText() Gets the text.
static XFI_concept_relationships.Axis	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static XFI_concept_relationships.Axis[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

child

public static final XFI_concept_relationships.Axis child

The child.

descendant

public static final XFI_concept_relationships.Axis descendant

The descendant.

parent

public static final XFI_concept_relationships.Axis parent

The parent.

ancestor

public static final XFI_concept_relationships.Axis ancestor

The ancestor.

sibling

public static final XFI_concept_relationships.Axis sibling

The sibling.

siblingOrDescendant

public static final XFI_concept_relationships.Axis siblingOrDescendant

The sibling or descendant.

Method Detail

values

public static XFI_concept_relationships.Axis[] 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 (XFI_concept_relationships.Axis c : XFI_concept_relationships.Axis.values())
    System.out.println(c);

Returns:

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

valueOf

public static XFI_concept_relationships.Axis 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

getText

public java.lang.String getText()

Gets the text.

Returns:

the text

fromString

public static XFI_concept_relationships.Axis fromString(java.lang.String text)
                                                 throws XFException

From string.

Parameters:

text - the text

Returns:

the axis

Throws:

XFException - the XF exception