org.xbrlapi.aspects
Class TupleAspect

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

All Implemented Interfaces:

Serializable, Aspect

public class TupleAspect
extends AspectImpl
implements Aspect

Tuple aspect details

The tuple aspect keeps track of whether facts are tuples or children of tuples or whether they are children of XBRL instances.

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

TupleAspect(Domain domain)

Method Summary

URI	getId()
TupleAspectValue	getMissingValue()
TupleAspectValue	getValue(Fact fact)
TupleAspectValue	getValue(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 final URI ID

The URI uniquely identifying this concept aspect.

Constructor Detail

TupleAspect

public TupleAspect(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 TupleAspectValue 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 TupleAspectValue getValue(Fragment parent)
                          throws XBRLException

Parameters:

parent - The fact's parent fragment

Returns:

the tuple aspect value based on the parent being a tuple or an XBRL instance.

Throws:

XBRLException

getMissingValue

public TupleAspectValue getMissingValue()

Specified by:

getMissingValue in interface Aspect

Returns:

the missing aspect value for this aspect.

See Also:

Aspect.getMissingValue()