org.xbrlapi.aspects

Class PeriodDomain

java.lang.Object

org.xbrlapi.aspects.DomainImpl

org.xbrlapi.aspects.PeriodDomain

All Implemented Interfaces:

java.io.Serializable, java.util.Comparator<AspectValue>, Domain, StoreHandler

public class PeriodDomain
extends DomainImpl
implements Domain

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PeriodDomain(Store store)

Method Summary

Methods

Modifier and Type	Method and Description
int	compare(AspectValue first, AspectValue second)
java.lang.String	getAspectId()
boolean	isInDomain(AspectValue candidate)

Methods inherited from class org.xbrlapi.aspects.DomainImpl

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xbrlapi.aspects.Domain

allowsMissingValues, getAllAspectValues, 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

Constructor Detail

PeriodDomain

public PeriodDomain(Store store)
             throws XBRLException

Throws:

XBRLException

Method Detail

getAspectId

public java.lang.String 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 java.util.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 date/time ordering of the end-date/instants and if that ordering is equal or indeterminate, on the date/time ordering of the start-date/instants. If the ordering remains indeterminate, then the periods are treated as equal. Missing values are ranked last among aspect values of the same type.