org.xbrlapi.aspects
Class SegmentAspect

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

All Implemented Interfaces:

Serializable, Aspect

public class SegmentAspect
extends AspectImpl
implements Aspect

Segment aspect details

Scenario aspects capture information in the context segment.

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

SegmentAspect(Domain domain)

Method Summary

URI	getId()
SegmentAspectValue	getMissingValue()
SegmentAspectValue	getValue(Context context)
SegmentAspectValue	getValue(Fact fact)
SegmentAspectValue	getValue(Segment segment)

Methods inherited from class org.xbrlapi.aspects.AspectImpl

getDomain, 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, isExtensible

Field Detail

ID

public static URI ID

The URI uniquely identifying this concept aspect.

Constructor Detail

SegmentAspect

public SegmentAspect(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 SegmentAspectValue 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 SegmentAspectValue getValue(Context context)
                            throws XBRLException

Specified by:

getValue in interface Aspect

Overrides:

getValue in class AspectImpl

Parameters:

context - The context to get the aspect value from.

Returns:

the aspect value for the context or the missing aspect value if the context does not define a value for the aspect.

Throws:

XBRLException

See Also:

Aspect.getValue(Context)

getValue

public SegmentAspectValue getValue(Segment segment)
                            throws XBRLException

Parameters:

segment - The context segment

Returns:

the saspect value.

Throws:

XBRLException

getMissingValue

public SegmentAspectValue getMissingValue()

Specified by:

getMissingValue in interface Aspect

Returns:

the missing aspect value for this aspect.

See Also:

Aspect.getMissingValue()