org.xbrlapi.aspects
Class LocationDomain

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

All Implemented Interfaces:

Serializable, Comparator<AspectValue>, Domain, StoreHandler

public class LocationDomain
extends DomainImpl
implements Domain, StoreHandler

See Also:

Serialized Form

Field Summary

protected static org.apache.log4j.Logger

logger

Constructor Summary

LocationDomain(Store store)

Method Summary

boolean	allowsMissingValues() This method is implemented by each concrete domain class.
int	compare(AspectValue first, AspectValue second)
List<AspectValue>	getAllAspectValues()
URI	getAspectId()
List<AspectValue>	getChildren(AspectValue parent)
int	getDepth(AspectValue aspectValue)
LocationAspectValue	getParent(AspectValue child)
long	getSize()
boolean	hasChildren(AspectValue value)
boolean	hasParent(AspectValue child)
boolean	isFinite() The getSize() and the getAllAspectValues methods must only be implemented if this method returns true.
boolean	isInDomain(AspectValue candidate)
boolean	isRoot(AspectValue aspectValue)

Methods inherited from class org.xbrlapi.aspects.DomainImpl

getStore

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.StoreHandler

getStore

Methods inherited from interface java.util.Comparator

equals

Field Detail

logger

protected static final org.apache.log4j.Logger logger

Constructor Detail

LocationDomain

public LocationDomain(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()

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()

getChildren

public List<AspectValue> getChildren(AspectValue parent)
                              throws XBRLException

Specified by:

getChildren in interface Domain

Overrides:

getChildren in class DomainImpl

Parameters:

parent - The parent aspect value.

Returns:

the ordered list of child aspect values for the given parent aspect value. The list is empty if there are no child aspect values in the domain for the given parent aspect value.

Throws:

XBRLException

See Also:

Domain.getChildren(AspectValue)

getDepth

public int getDepth(AspectValue aspectValue)
             throws XBRLException

Specified by:

getDepth in interface Domain

Overrides:

getDepth in class DomainImpl

Parameters:

aspectValue - The aspect value whose ancestor aspect values are to be counted.

Returns:

the number of ancestor aspect values that this aspect value has in this domain. The return value will be zero if the domain does not define a heirarchical ordering of aspect values.

Throws:

XBRLException

See Also:

Domain.getDepth(AspectValue)

getParent

public LocationAspectValue getParent(AspectValue child)
                              throws XBRLException

Specified by:

getParent in interface Domain

Overrides:

getParent in class DomainImpl

Parameters:

child - The aspect value.

Returns:

the parent aspect value.

Throws:

XBRLException - if the aspect value does not have a parent.

See Also:

Domain.getParent(AspectValue)

getSize

public long getSize()
             throws XBRLException

Specified by:

getSize in interface Domain

Overrides:

getSize in class DomainImpl

Returns:

the number of aspect values in the domain or null if the domain size is infinite.

Throws:

XBRLException

See Also:

Domain.getSize()

hasChildren

public boolean hasChildren(AspectValue value)
                    throws XBRLException

Specified by:

hasChildren in interface Domain

Overrides:

hasChildren in class DomainImpl

Parameters:

value - The aspect value.

Returns:

true if the aspect value has child aspect values and false otherwise.

Throws:

XBRLException

See Also:

Domain.hasChildren(AspectValue)

hasParent

public boolean hasParent(AspectValue child)
                  throws XBRLException

Specified by:

hasParent in interface Domain

Overrides:

hasParent in class DomainImpl

Parameters:

child - The child aspect value.

Returns:

true if this aspect value has a parent aspect value in the aspect model and false otherwise.

Throws:

XBRLException

See Also:

Domain.hasParent(AspectValue)

isInDomain

public boolean isInDomain(AspectValue candidate)

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.

See Also:

Domain.isInDomain(AspectValue)

isFinite

public boolean isFinite()

Description copied from interface: Domain

The getSize() and the getAllAspectValues methods must only be implemented if this method returns true. Otherwise they need to throw an exception.

Specified by:

isFinite in interface Domain

Overrides:

isFinite in class DomainImpl

Returns:

true if the domain has a finite number of members in it and false otherwise.

See Also:

Domain.isFinite()

allowsMissingValues

public boolean allowsMissingValues()

Description copied from interface: Domain

This method is implemented by each concrete domain class.

Specified by:

allowsMissingValues in interface Domain

Overrides:

allowsMissingValues in class DomainImpl

Returns:

false.

See Also:

Domain.allowsMissingValues()

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, treating the document part of the identifier as a string and the fragment number within the document as an integer. Missing values are ranked last among aspect values of the same type.

isRoot

public boolean isRoot(AspectValue aspectValue)
               throws XBRLException

Specified by:

isRoot in interface Domain

Overrides:

isRoot in class DomainImpl

Parameters:

aspectValue - The aspect value to test.

Returns:

true if and only if the aspect value has depth of zero.

Throws:

XBRLException

See Also:

Domain.isRoot(AspectValue)