com.ihr.xbrl.om.aspects

Class Aspects

java.lang.Object

com.ihr.xbrl.om.aspects.Aspects

public abstract class Aspects
extends java.lang.Object

The Class Aspects.

Author:

Ignacio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Aspects.AspectCode Provides enumeration and bitmap of main aspect codes.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Set<Aspect>	ALLDIMENSIONALASPECTS The Constant ALLDIMENSIONALASPECTS.
static java.util.Set<Aspect>	ALLNONDIMENSIONALASPECTS The Constant ALLNONDIMENSIONALASPECTS.
static java.util.Set<Aspect>	ANY The Constant ANY.
static java.lang.String	ASPECTSNAMESPACE This namespace is used in the API to create QNames for statically defined aspects the namespace declaration is http://www.reportingstandard.com/namespaces/aspects
static Aspect	COMPLETESCENARIO The COMPLETESCENARIO static aspect.
static Aspect	COMPLETESEGMENT The COMPLETESEGMENT static aspect.
static Aspect	CONCEPT The CONCEPT static aspect.
static Aspect	CONTEXT The VALUE static aspect.
static Aspect	DIMENSION The DIMENSION static aspect.
static Aspect	ENTITYIDENTIFIER The ENTITYIDENTIFIER static aspect.
static Aspect	LOCATION The LOCATION static aspect.
static Aspect	NONXDTSCENARIO The NONXDTSCENARIO static aspect.
static Aspect	NONXDTSEGMENT The NONXDTSEGMENT static aspect.
static Aspect	NULL A constant to identify NO Aspect or null aspect.
static Aspect	PERIOD The PERIOD static aspect.
static Aspect	UNIT The UNIT static aspect.
static Aspect	VALUE The VALUE static aspect.

Method Summary

Modifier and Type	Method and Description
static int	combineAspects(java.util.Set<Aspect> set) Returns an integer that contains bit coded information about the aspects set.
static java.lang.String	getAspectName(Aspect aspect) Aspects are defined as constants (QNames) where the namespace is from Reporting Standard.
static java.lang.String	getAspectsText(java.util.Set<Aspect> aspects, XBRLFormulaFilter filter) This is for debugging purposes only.
static java.util.Set<Aspect>	make(Aspect aspect) Make.
java.util.Set<Aspect>	separateAspects(int aspect) Returns a new Set of Aspect by evaluating all bits corresponding to Aspects in the aspect parameter.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ASPECTSNAMESPACE

public static final java.lang.String ASPECTSNAMESPACE

This namespace is used in the API to create QNames for statically defined aspects the namespace declaration is http://www.reportingstandard.com/namespaces/aspects

See Also:

Constant Field Values

NULL

public static final Aspect NULL

A constant to identify NO Aspect or null aspect.

LOCATION

public static final Aspect LOCATION

The LOCATION static aspect.

CONCEPT

public static final Aspect CONCEPT

The CONCEPT static aspect.

ENTITYIDENTIFIER

public static final Aspect ENTITYIDENTIFIER

The ENTITYIDENTIFIER static aspect.

PERIOD

public static final Aspect PERIOD

The PERIOD static aspect.

UNIT

public static final Aspect UNIT

The UNIT static aspect.

COMPLETESEGMENT

public static final Aspect COMPLETESEGMENT

The COMPLETESEGMENT static aspect.

COMPLETESCENARIO

public static final Aspect COMPLETESCENARIO

The COMPLETESCENARIO static aspect.

NONXDTSEGMENT

public static final Aspect NONXDTSEGMENT

The NONXDTSEGMENT static aspect.

NONXDTSCENARIO

public static final Aspect NONXDTSCENARIO

The NONXDTSCENARIO static aspect.

DIMENSION

public static final Aspect DIMENSION

The DIMENSION static aspect.

VALUE

public static final Aspect VALUE

The VALUE static aspect.

CONTEXT

public static final Aspect CONTEXT

The VALUE static aspect.

ALLDIMENSIONALASPECTS

public static final java.util.Set<Aspect> ALLDIMENSIONALASPECTS

The Constant ALLDIMENSIONALASPECTS.

ALLNONDIMENSIONALASPECTS

public static final java.util.Set<Aspect> ALLNONDIMENSIONALASPECTS

The Constant ALLNONDIMENSIONALASPECTS.

ANY

public static final java.util.Set<Aspect> ANY

The Constant ANY.

Method Detail

getAspectsText

public static java.lang.String getAspectsText(java.util.Set<Aspect> aspects,
                                              XBRLFormulaFilter filter)

This is for debugging purposes only.

Parameters:

aspects - the aspects

filter - the filter

Returns:

the aspects text

make

public static java.util.Set<Aspect> make(Aspect aspect)

Make.

Parameters:

aspect - the aspect

Returns:

the sets the

combineAspects

public static int combineAspects(java.util.Set<Aspect> set)

Returns an integer that contains bit coded information about the aspects set. Every aspect in the AspectCode enumeration is defined as a unique bit 2^aspectNumber

Parameters:

set - of aspects to combine

Returns:

this method returns a bit OR operation on all aspect codes in the set

separateAspects

public java.util.Set<Aspect> separateAspects(int aspect)

Returns a new Set of Aspect by evaluating all bits corresponding to Aspects in the aspect parameter.

Parameters:

aspect - the aspect

Returns:

new Set of Aspect instances

getAspectName

public static java.lang.String getAspectName(Aspect aspect)

Aspects are defined as constants (QNames) where the namespace is from Reporting Standard. The Functions conformance suite has created some functions that required the aspect name to match specific tokens. This method converts from our QNames to the specification names

Parameters:

aspect - the aspect

Returns:

the aspect name