org.xbrlapi.aspects
Class LocationAspect

java.lang.Object
  org.xbrlapi.aspects.AspectImpl
      org.xbrlapi.aspects.LocationAspect

All Implemented Interfaces:

Serializable, Aspect

public class LocationAspect
extends AspectImpl
implements Aspect

Location aspect details

All facts have a value for the location aspect. The location aspect reflects the containers of the fact. This includes the containing XBRL instance and any tuple ancestors of the fact.

Author:

Geoff Shuetrim (geoff@galexy.net)

See Also:

Serialized Form

Field Summary

static URI

ID The URI uniquely identifying this concept aspect.

Fields inherited from class org.xbrlapi.aspects.AspectImpl

domain

Constructor Summary

LocationAspect(Domain domain)

Method Summary

URI	getId()
LocationAspectValue	getMissingValue()
LocationAspectValue	getValue(Fact fact)
LocationAspectValue	getValue(Fact fact, Fragment parent)

Methods inherited from class org.xbrlapi.aspects.AspectImpl

getDomain, getValue, getValue, isExtensible

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

getDomain, getValue, getValue, isExtensible

Field Detail

ID

public static URI ID

The URI uniquely identifying this concept aspect.

Constructor Detail

LocationAspect

public LocationAspect(Domain domain)
               throws XBRLException

Parameters:

domain - The domain for this aspect.

Throws:

XBRLException

Method Detail

getId

public URI getId()

Specified by:

getId in interface Aspect

Returns:

the URI that identifies this aspect.

See Also:

Aspect.getId()

getValue

public LocationAspectValue getValue(Fact fact)
                             throws XBRLException

Specified by:

getValue in interface Aspect

Parameters:

fact - The fact to get the aspect value for.

Returns:

a value for this aspect for the given fact.

Throws:

XBRLException

See Also:

Aspect.getValue(Fact)

getValue

public LocationAspectValue getValue(Fact fact,
                                    Fragment parent)
                             throws XBRLException

Parameters:

fact - The fact

parent - The parent fragment of the fact

Returns:

The location aspect value.

Throws:

XBRLException

getMissingValue

public LocationAspectValue getMissingValue()

Specified by:

getMissingValue in interface Aspect

Returns:

the missing aspect value for this aspect.

See Also:

Aspect.getMissingValue()