org.xbrlapi.aspects
Class EntityDomain

java.lang.Object
  org.xbrlapi.aspects.DomainImpl
      org.xbrlapi.aspects.EntityDomain

All Implemented Interfaces:

Serializable, Comparator<AspectValue>, Domain, StoreHandler

public class EntityDomain
extends DomainImpl
implements Domain

See Also:

Serialized Form

Field Summary

protected static org.apache.log4j.Logger

logger

Constructor Summary

EntityDomain(Store store)

Method Summary

int	compare(AspectValue first, AspectValue second)
List<AspectValue>	getAllAspectValues()
URI	getAspectId()
boolean	isInDomain(AspectValue candidate)

Methods inherited from class org.xbrlapi.aspects.DomainImpl

allowsMissingValues, getChildren, getDepth, getParent, getSize, getStore, hasChildren, hasParent, isFinite, isRoot

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xbrlapi.aspects.Domain

allowsMissingValues, getChildren, getDepth, getParent, getSize, hasChildren, hasParent, isFinite, isRoot

Methods inherited from interface org.xbrlapi.aspects.StoreHandler

getStore

Methods inherited from interface java.util.Comparator

equals

Field Detail

logger

protected static final org.apache.log4j.Logger logger

Constructor Detail

EntityDomain

public EntityDomain(Store store)
             throws XBRLException

Throws:

XBRLException

Method Detail

getAspectId

public URI getAspectId()

Specified by:

getAspectId in interface Domain

Returns:

the URI identifying the aspect that this is a domain for.

See Also:

Domain.getAspectId()

isInDomain

public boolean isInDomain(AspectValue candidate)
                   throws XBRLException

Specified by:

isInDomain in interface Domain

Parameters:

candidate - The candidate aspect value.

Returns:

true if the aspect value is in the domain and false otherwise.

Throws:

XBRLException

See Also:

Domain.isInDomain(AspectValue)

compare

public int compare(AspectValue first,
                   AspectValue second)

Specified by:

compare in interface Comparator<AspectValue>

Parameters:

first - The first aspect value

second - The second aspect value

Returns:

-1 if the first aspect value is less than the second, 0 if they are equal and 1 if the first aspect value is greater than the second. Any aspect values that are not in this domain are placed last in the aspect value ordering. Otherwise, the comparison is based upon the natural ordering of the aspect value IDs. Missing values are ranked last among aspect values of the same type.

getAllAspectValues

public List<AspectValue> getAllAspectValues()
                                     throws XBRLException

Specified by:

getAllAspectValues in interface Domain

Overrides:

getAllAspectValues in class DomainImpl

Returns:

a list of all of the aspect values in the domain except for the missing value. The list is ordered based on a depth first traversal of the aspect values in the domain. Thus, parent values come immediately before their child values and child values are sorted by their strict ordering if there is one.

Throws:

XBRLException

See Also:

Domain.getAllAspectValues()