XBRLAPI

A Java API for XBRL


Serialized Form


Package org.xbrlapi

Package org.xbrlapi.aspects

Class org.xbrlapi.aspects.AspectImpl extends Object implements Serializable

serialVersionUID: -255457317327893545L

Serialized Fields

domain

Domain domain

Class org.xbrlapi.aspects.AspectModelImpl extends Object implements Serializable

serialVersionUID: 4240229374124118822L

Serialized Fields

axes

com.google.common.collect.ListMultimap<K,V> axes
Map from axis names to lists of the aspects in that axis.

 

aspects

Map<K,V> aspects
Map from aspect IDs to the aspect implementations being used.

 

labellers

Map<K,V> labellers
Map from aspect IDs to the aspect labellers being used.

 

defaultAxis

String defaultAxis
The axis of the aspect model to add new aspects to by default. This defaults to "orphan".

 

store

Store store
The data store used to define some of the standard aspects.

 

Class org.xbrlapi.aspects.AspectValueImpl extends Object implements Serializable

serialVersionUID: 5016688902526266720L

Class org.xbrlapi.aspects.BaseLabeller extends LabellerImpl implements Serializable

serialVersionUID: -5977720545872502374L

Class org.xbrlapi.aspects.CachingLabeller extends BaseLabeller implements Serializable

serialVersionUID: 5414469666286671643L

Serialized Fields

labeller

Labeller labeller

cache

LabelCache cache
The aspect value label caching system.

Class org.xbrlapi.aspects.CombinationsImpl extends Object implements Serializable

serialVersionUID: -6280457826226771955L

Serialized Fields

model

AspectModel model
The aspect model in use.


aspectValues

HashMap<K,V> aspectValues
The map from Aspect IDs to the lists of aspect values .


axis

String axis
The axis of the aspect model defining the aspects to get combinations of values for.

Class org.xbrlapi.aspects.ConceptAspect extends AspectImpl implements Serializable

serialVersionUID: -1595719766119532306L

Class org.xbrlapi.aspects.ConceptAspectValue extends AspectValueImpl implements Serializable

serialVersionUID: 5049800914749987634L

Serialized Fields

namespace

URI namespace
The namespace of the concept associated with this aspect value.


localname

String localname
The namespace of the concept associated with this aspect value.

Class org.xbrlapi.aspects.ConceptDomain extends DomainImpl implements Serializable

serialVersionUID: 8182173364220660426L

Class org.xbrlapi.aspects.ConceptLabeller extends BaseLabeller implements Serializable

serialVersionUID: -2179477289946077839L

Class org.xbrlapi.aspects.DomainImpl extends Object implements Serializable

serialVersionUID: -5823499517209750972L

Serialized Fields

store

Store store
The underlying store.

Class org.xbrlapi.aspects.EntityAspect extends AspectImpl implements Serializable

serialVersionUID: -5421107025896386283L

Class org.xbrlapi.aspects.EntityAspectValue extends AspectValueImpl implements Serializable

serialVersionUID: -5629903281523671450L

Serialized Fields

scheme

URI scheme
The entity identification scheme.


value

String value
The entity identification value.

Class org.xbrlapi.aspects.EntityDomain extends DomainImpl implements Serializable

serialVersionUID: -1574457177945271318L

Class org.xbrlapi.aspects.EntityLabeller extends BaseLabeller implements Serializable

serialVersionUID: -2263929608570454217L

Class org.xbrlapi.aspects.FactSetImpl extends Object implements Serializable

serialVersionUID: 4346339645057432855L

Serialized Fields

valueMap

com.google.common.collect.Multimap<K,V> valueMap
A map from one aspect value to multiple facts.


factMap

com.google.common.collect.Multimap<K,V> factMap
A map from one fact to multiple aspect values.


aspectMap

com.google.common.collect.Multimap<K,V> aspectMap
A map from aspect IDs to the values for that aspect.


model

AspectModel model
The aspect model that is being used.


localCache

HashMap<K,V> localCache
Local hash map for caching aspect value labels.

Class org.xbrlapi.aspects.FilterImpl extends Object implements Serializable

serialVersionUID: -2594177408479622078L

Serialized Fields

map

Map<K,V> map
The map of selection criteria.

Class org.xbrlapi.aspects.LabellerImpl extends Object implements Serializable

serialVersionUID: 519089390627009535L

Serialized Fields

aspect

Aspect aspect
The aspect that this labeller deals with.

Class org.xbrlapi.aspects.LocationAspect extends AspectImpl implements Serializable

serialVersionUID: -7841916801129980666L

Class org.xbrlapi.aspects.LocationAspectValue extends AspectValueImpl implements Serializable

serialVersionUID: -9147415332504512016L

Serialized Fields

factIndex

String factIndex
The index of the fact.


parentFactIndex

String parentFactIndex
The index of the parent fact - null for facts that are children of the containing XBRL instance.

Class org.xbrlapi.aspects.LocationDomain extends DomainImpl implements Serializable

serialVersionUID: 6991871946096405025L

Class org.xbrlapi.aspects.LocationLabeller extends LabellerImpl implements Serializable

serialVersionUID: -5874874175254475089L

Class org.xbrlapi.aspects.MemoryLabelCache extends Object implements Serializable

serialVersionUID: -6478712477019768054L

Serialized Fields

map

Map<K,V> map

fallbackMap

Map<K,V> fallbackMap

Class org.xbrlapi.aspects.PeriodAspect extends AspectImpl implements Serializable

serialVersionUID: -8787755650749959353L

Class org.xbrlapi.aspects.PeriodAspectValue extends AspectValueImpl implements Serializable

serialVersionUID: -5811178785037672992L

Serialized Fields

isMissing

boolean isMissing
Flag for missing period aspect values.


start

XMLGregorianCalendar start
The start and end dates for periods. The end is for instants and the ends of finite durations.


endOrInstant

XMLGregorianCalendar endOrInstant
The start and end dates for periods. The end is for instants and the ends of finite durations.


rawStart

String rawStart
The start and end date/instant date string values as given in the XBRL contexts. The rawEnd is used for ends of finite durations and for instants.


rawEndOrInstant

String rawEndOrInstant

startDateOnly

boolean startDateOnly
The boolean flags for date/only values


endDateOnly

boolean endDateOnly
The boolean flags for date/only values


isForever

boolean isForever
Flag for null period aspect values.

Class org.xbrlapi.aspects.PeriodDomain extends DomainImpl implements Serializable

serialVersionUID: -4367394263354299714L

Class org.xbrlapi.aspects.PeriodLabeller extends BaseLabeller implements Serializable

serialVersionUID: 3865956219152605139L

Class org.xbrlapi.aspects.PeriodLabellerNaive extends BaseLabeller implements Serializable

serialVersionUID: -3350666647416995000L

Class org.xbrlapi.aspects.PeriodLabellerQuarters extends LabellerImpl implements Serializable

serialVersionUID: -7514872059852959452L

Class org.xbrlapi.aspects.ScenarioAspect extends AspectImpl implements Serializable

serialVersionUID: 7357414426851438249L

Class org.xbrlapi.aspects.ScenarioAspectValue extends AspectValueImpl implements Serializable

serialVersionUID: 6282654205736211983L

Serialized Fields

children

List<E> children
The list of child elements of the segment or null if the segment aspect value is missing.


id

String id
The missing aspect value ID is the empty string.

See Also:
AspectValue.getId()

Class org.xbrlapi.aspects.ScenarioDomain extends DomainImpl implements Serializable

serialVersionUID: 7377379604553778732L

Class org.xbrlapi.aspects.ScenarioLabeller extends BaseLabeller implements Serializable

serialVersionUID: 7314875682855781871L

Class org.xbrlapi.aspects.SegmentAspect extends AspectImpl implements Serializable

serialVersionUID: 6762933296532647581L

Class org.xbrlapi.aspects.SegmentAspectValue extends AspectValueImpl implements Serializable

serialVersionUID: 647891872633073205L

Serialized Fields

children

List<E> children
The list of child elements of the segment or null if the segment aspect value is missing.


id

String id
The missing aspect value ID is the empty string.

See Also:
AspectValue.getId()

Class org.xbrlapi.aspects.SegmentDomain extends DomainImpl implements Serializable

serialVersionUID: 3490647122580245339L

Class org.xbrlapi.aspects.SegmentLabeller extends BaseLabeller implements Serializable

serialVersionUID: -4659311007619482199L

Class org.xbrlapi.aspects.StandardAspectModel extends AspectModelImpl implements Serializable

serialVersionUID: -7677982636300869250L

Class org.xbrlapi.aspects.StandardAspectModelWithMemoryCachingLabellers extends StandardAspectModel implements Serializable

serialVersionUID: 5288184252388411327L

Class org.xbrlapi.aspects.StandardAspectModelWithStoreCachingLabellers extends StandardAspectModel implements Serializable

serialVersionUID: 5288184252388411327L

Class org.xbrlapi.aspects.StoreLabelCache extends Object implements Serializable

serialVersionUID: -1322629918281873648L

Serialized Fields

store

Store store
The data store used to cache aspect value labels.

Class org.xbrlapi.aspects.TupleAspect extends AspectImpl implements Serializable

serialVersionUID: 7795484614533602772L

Class org.xbrlapi.aspects.TupleAspectValue extends AspectValueImpl implements Serializable

serialVersionUID: 4497623473009130035L

Serialized Fields

isTuple

Boolean isTuple
The boolean flag indicating if the fact is a tuple or not.

Class org.xbrlapi.aspects.TupleDomain extends DomainImpl implements Serializable

serialVersionUID: -7809445921191054988L

Class org.xbrlapi.aspects.TupleLabeller extends BaseLabeller implements Serializable

serialVersionUID: 3161673708249240447L

Class org.xbrlapi.aspects.UnitAspect extends AspectImpl implements Serializable

serialVersionUID: 6762933296532647581L

Class org.xbrlapi.aspects.UnitAspectValue extends AspectValueImpl implements Serializable

serialVersionUID: 6028909248578218123L

Serialized Fields

numerators

List<E> numerators
Missing values are indicated by an empty list of numerator measures. The numerator measures in the unit.


denominators

List<E> denominators
The denominator measures in the unit.

Class org.xbrlapi.aspects.UnitDomain extends DomainImpl implements Serializable

serialVersionUID: -325225007282008875L

Class org.xbrlapi.aspects.UnitLabeller extends BaseLabeller implements Serializable

serialVersionUID: -6541770175584344223L


Package org.xbrlapi.cache

Class org.xbrlapi.cache.CacheImpl extends Object implements Serializable

serialVersionUID: -4518163581910550322L

Serialized Fields

cacheRoot

File cacheRoot
Root of the local document cache.


uriMap

HashMap<K,V> uriMap
The map of local URIs to use in place of original URIs. The original URI points to the local URI in the map that is used.


Package org.xbrlapi.data

Class org.xbrlapi.data.BaseStoreImpl extends Object implements Serializable

serialVersionUID: -3709078033252193797L

Serialized Fields

matcher

Matcher matcher
Resource matcher


namespaceBindings

HashMap<K,V> namespaceBindings
Namespace bindings


uris

Set<E> uris
Set of URIs to use when filtering query results to only get matches to a specific set of documents.


Package org.xbrlapi.data.bdbxml

Class org.xbrlapi.data.bdbxml.StoreImpl extends BaseStoreImpl implements Serializable

serialVersionUID: 668818404270811849L

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
                        ClassNotFoundException
Handles object inflation.

Throws:
IOException
ClassNotFoundException
Serialized Fields

computerIdentity

String computerIdentity

locationName

String locationName

containerName

String containerName

CACHE_SIZE

int CACHE_SIZE

queryEvaluationType

int queryEvaluationType
Defines the default evaluation approach.


Package org.xbrlapi.data.dom

Class org.xbrlapi.data.dom.StoreImpl extends BaseStoreImpl implements Serializable

serialVersionUID: 4176301844348514277L

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
                        ClassNotFoundException
Handles object inflation.

Throws:
IOException
ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException
Handles object serialization

Throws:
IOException

Package org.xbrlapi.data.exist

Class org.xbrlapi.data.exist.StoreImpl extends BaseStoreImpl implements Serializable

serialVersionUID: 3164980656484788937L

Serialized Fields

computerId

String computerId

host

String host

port

String port

database

String database

username

String username

password

String password

storeParentPath

String storeParentPath

dataCollectionName

String dataCollectionName

Package org.xbrlapi.data.exist.embedded

Class org.xbrlapi.data.exist.embedded.StoreImpl extends BaseStoreImpl implements Serializable

serialVersionUID: 765193783985034637L

Serialized Fields

builder

XMLDOMBuilder builder

computerId

String computerId

host

String host

port

String port

database

String database

username

String username

password

String password

storeParentPath

String storeParentPath

dataCollectionName

String dataCollectionName

Package org.xbrlapi.data.resource

Class org.xbrlapi.data.resource.BaseMatcherImpl extends Object implements Serializable

serialVersionUID: -3402075120037095009L

Serialized Fields

cache

Cache cache
The cache implementation to be used by the matcher when accessing resources. If this is null, then no cache is used.


signer

Signer signer

Class org.xbrlapi.data.resource.DefaultMatcherImpl extends Object implements Serializable

serialVersionUID: -2009126809674227559L

Class org.xbrlapi.data.resource.InMemoryMatcherImpl extends BaseMatcherImpl implements Serializable

serialVersionUID: 1224199711979462774L

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
                        ClassNotFoundException
Handles object inflation.

Throws:
IOException
ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException
Handles object serialization

Throws:
IOException
Serialized Fields

map

Map<K,V> map
Map from signature strings to lists of URIs with the same signature. The first URI in the list is the URI of the resource in the data store.

Class org.xbrlapi.data.resource.InStoreMatcherImpl extends BaseMatcherImpl implements Serializable

serialVersionUID: -2815835104865947253L

Serialized Fields

store

Store store
The store in which the information about matched URIs is to be retained.

Class org.xbrlapi.data.resource.MD5SignerImpl extends Object implements Serializable

serialVersionUID: -4391859287548042192L


Package org.xbrlapi.impl

Class org.xbrlapi.impl.ArcEndImpl extends ExtendedLinkContentImpl implements Serializable

serialVersionUID: 8789093562540648488L

Class org.xbrlapi.impl.ArcImpl extends ExtendedLinkContentImpl implements Serializable

serialVersionUID: -5826492379826212317L

Class org.xbrlapi.impl.ArcroleTypeImpl extends CustomTypeImpl implements Serializable

serialVersionUID: -3510310341148593799L

Class org.xbrlapi.impl.AspectValueLabelImpl extends NonFragmentXMLImpl implements Serializable

serialVersionUID: 4657502706837130397L

Class org.xbrlapi.impl.AspectValuePairImpl extends NonFragmentXMLImpl implements Serializable

serialVersionUID: 9141633045533213712L

Class org.xbrlapi.impl.AttributeDeclarationImpl extends SchemaContentDeclarationImpl implements Serializable

serialVersionUID: 7060377316448918942L

Class org.xbrlapi.impl.AttributeGroupDeclarationImpl extends SchemaDeclarationImpl implements Serializable

serialVersionUID: -7206086803716730160L

Class org.xbrlapi.impl.ComplexTypeDeclarationImpl extends TypeDeclarationImpl implements Serializable

serialVersionUID: 4929601557073607819L

Class org.xbrlapi.impl.ConceptImpl extends ElementDeclarationImpl implements Serializable

serialVersionUID: -1067935705927988286L

Class org.xbrlapi.impl.ContextComponentImpl extends FragmentImpl implements Serializable

serialVersionUID: -4641121755978081684L

Class org.xbrlapi.impl.ContextImpl extends FactDimensionContainerImpl implements Serializable

serialVersionUID: 875204843953696951L

Class org.xbrlapi.impl.CustomTypeImpl extends FragmentImpl implements Serializable

serialVersionUID: -3481150284083534384L

Class org.xbrlapi.impl.ElementDeclarationImpl extends SchemaContentDeclarationImpl implements Serializable

serialVersionUID: -4686068793132435426L

Class org.xbrlapi.impl.EntityImpl extends ContextComponentImpl implements Serializable

serialVersionUID: -2026972763772352159L

Class org.xbrlapi.impl.EntityResourceImpl extends MixedContentResourceImpl implements Serializable

serialVersionUID: 5964964039469483783L

Class org.xbrlapi.impl.ErrorImpl extends XMLImpl implements Serializable

serialVersionUID: 2965459874023212117L

Class org.xbrlapi.impl.ExtendedLinkContentImpl extends org.xbrlapi.impl.XlinkImpl implements Serializable

serialVersionUID: 5152171927354071767L

Class org.xbrlapi.impl.ExtendedLinkImpl extends LinkImpl implements Serializable

serialVersionUID: -5810751426509975700L

Class org.xbrlapi.impl.FactDimensionContainerImpl extends FragmentImpl implements Serializable

serialVersionUID: -6970469751478915472L

Class org.xbrlapi.impl.FactImpl extends FragmentImpl implements Serializable

serialVersionUID: 5557580425035320023L

Class org.xbrlapi.impl.FootnoteResourceImpl extends MixedContentResourceImpl implements Serializable

serialVersionUID: -8875808422865876140L

Class org.xbrlapi.impl.FractionItemImpl extends NumericItemImpl implements Serializable

serialVersionUID: -6689670696924267352L

Class org.xbrlapi.impl.FragmentImpl extends XMLImpl implements Serializable

serialVersionUID: 8591668366284792007L

Class org.xbrlapi.impl.InstanceImpl extends FragmentImpl implements Serializable

serialVersionUID: -3931256042051791132L

Class org.xbrlapi.impl.ItemImpl extends FactImpl implements Serializable

serialVersionUID: 5737055509180629932L

Class org.xbrlapi.impl.LabelResourceImpl extends MixedContentResourceImpl implements Serializable

serialVersionUID: 6478578009264842169L

Class org.xbrlapi.impl.LanguageImpl extends FragmentImpl implements Serializable

serialVersionUID: 1549365928850844441L

Class org.xbrlapi.impl.LinkbaseImpl extends FragmentImpl implements Serializable

serialVersionUID: -5344292511314590729L

Class org.xbrlapi.impl.LinkImpl extends org.xbrlapi.impl.XlinkImpl implements Serializable

serialVersionUID: 6703189602306256819L

Class org.xbrlapi.impl.LocatorImpl extends ArcEndImpl implements Serializable

serialVersionUID: 2954795492246579940L

Class org.xbrlapi.impl.MatchImpl extends NonFragmentXMLImpl implements Serializable

serialVersionUID: 3738588761407998990L

Class org.xbrlapi.impl.MeasureImpl extends Object implements Serializable

serialVersionUID: -3990813740480933241L

Serialized Fields

namespace

URI namespace

localname

String localname

Class org.xbrlapi.impl.MeasureResourceImpl extends MixedContentResourceImpl implements Serializable

serialVersionUID: -8882117229431178772L

Class org.xbrlapi.impl.MixedContentResourceImpl extends ResourceImpl implements Serializable

serialVersionUID: 4954206459559699372L

Class org.xbrlapi.impl.MockImpl extends FragmentImpl implements Serializable

serialVersionUID: 31223298171306717L

Class org.xbrlapi.impl.NetworkGraphImpl extends NonFragmentXMLImpl implements Serializable

serialVersionUID: -2784004296852207174L

Class org.xbrlapi.impl.NonFragmentXMLImpl extends XMLImpl implements Serializable

serialVersionUID: -30309765269122246L

Class org.xbrlapi.impl.NonNumericItemImpl extends ItemImpl implements Serializable

serialVersionUID: -679088686747723914L

Class org.xbrlapi.impl.NumericItemImpl extends ItemImpl implements Serializable

serialVersionUID: -2601049145050399109L

Class org.xbrlapi.impl.OpenContextComponentImpl extends ContextComponentImpl implements Serializable

serialVersionUID: -4911717815217702354L

Class org.xbrlapi.impl.PeriodImpl extends ContextComponentImpl implements Serializable

serialVersionUID: -6599852248292348434L

Class org.xbrlapi.impl.ReferencePartDeclarationImpl extends ElementDeclarationImpl implements Serializable

serialVersionUID: 2641797838964063144L

Class org.xbrlapi.impl.ReferencePartImpl extends FragmentImpl implements Serializable

serialVersionUID: 2432919060384094098L

Class org.xbrlapi.impl.ReferenceResourceImpl extends MixedContentResourceImpl implements Serializable

serialVersionUID: 2397300422957891874L

Class org.xbrlapi.impl.RelationshipImpl extends NonFragmentXMLImpl implements Serializable

serialVersionUID: -8152142828118166919L

Class org.xbrlapi.impl.ResourceImpl extends ArcEndImpl implements Serializable

serialVersionUID: -3515868937307864773L

Class org.xbrlapi.impl.RoleTypeImpl extends CustomTypeImpl implements Serializable

serialVersionUID: 2596352804658433028L

Class org.xbrlapi.impl.ScenarioImpl extends OpenContextComponentImpl implements Serializable

serialVersionUID: 5647697296385818230L

Class org.xbrlapi.impl.SchemaAllCompositorImpl extends SchemaCompositorImpl implements Serializable

serialVersionUID: -4123274191036423849L

Class org.xbrlapi.impl.SchemaChoiceCompositorImpl extends SchemaCompositorImpl implements Serializable

serialVersionUID: 1652892957698636841L

Class org.xbrlapi.impl.SchemaCompositorImpl extends SchemaContentImpl implements Serializable

serialVersionUID: 985343575694203047L

Class org.xbrlapi.impl.SchemaContentDeclarationImpl extends SchemaDeclarationImpl implements Serializable

serialVersionUID: 5486099839583917186L

Class org.xbrlapi.impl.SchemaContentImpl extends FragmentImpl implements Serializable

serialVersionUID: 1132807733882600038L

Class org.xbrlapi.impl.SchemaDeclarationImpl extends SchemaContentImpl implements Serializable

serialVersionUID: 3358079880954000640L

Class org.xbrlapi.impl.SchemaGroupCompositorImpl extends SchemaCompositorImpl implements Serializable

serialVersionUID: -8785959698754119764L

Class org.xbrlapi.impl.SchemaImpl extends SchemaContentImpl implements Serializable

serialVersionUID: -7823792162479874585L

Class org.xbrlapi.impl.SchemaSequenceCompositorImpl extends SchemaCompositorImpl implements Serializable

serialVersionUID: -6954914669378049258L

Class org.xbrlapi.impl.SegmentImpl extends OpenContextComponentImpl implements Serializable

serialVersionUID: 2635173824228869410L

Class org.xbrlapi.impl.SimpleLinkImpl extends LinkImpl implements Serializable

serialVersionUID: 2102431228976024539L

Class org.xbrlapi.impl.SimpleNumericItemImpl extends NumericItemImpl implements Serializable

serialVersionUID: 5023073637732952730L

Class org.xbrlapi.impl.SimpleTypeDeclarationImpl extends TypeDeclarationImpl implements Serializable

serialVersionUID: 5759072150532607196L

Class org.xbrlapi.impl.StubImpl extends NonFragmentXMLImpl implements Serializable

serialVersionUID: 4672320267418877015L

Class org.xbrlapi.impl.TitleImpl extends org.xbrlapi.impl.XlinkImpl implements Serializable

serialVersionUID: 3219710333476685455L

Class org.xbrlapi.impl.TupleImpl extends FactImpl implements Serializable

serialVersionUID: 8236154180347375942L

Class org.xbrlapi.impl.TypeDeclarationImpl extends SchemaDeclarationImpl implements Serializable

serialVersionUID: 1297992906402945120L

Class org.xbrlapi.impl.UnitImpl extends FactDimensionContainerImpl implements Serializable

serialVersionUID: 3483030594929689605L

Class org.xbrlapi.impl.UsedOnImpl extends FragmentImpl implements Serializable

serialVersionUID: 2691745089747004020L

Class org.xbrlapi.impl.XlinkDocumentationImpl extends FragmentImpl implements Serializable

serialVersionUID: -8362102502686134852L

Class org.xbrlapi.impl.XMLImpl extends Object implements Serializable

serialVersionUID: 8783657613634421905L

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
                        ClassNotFoundException
Handles object inflation.

Throws:
IOException
ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException
Handles serialization for XML resources that have been fully built.

Throws:
IOException - if the object is still being built.
Serialized Fields

store

Store store
The data store that manages this fragment.


rootElement

Element rootElement
The DOM instantiation of the fragment's root element or null if the fragment has not been built.


Package org.xbrlapi.loader

Class org.xbrlapi.loader.HistoryImpl extends Object implements Serializable

serialVersionUID: -4599201126216530103L

Class org.xbrlapi.loader.LoaderImpl extends Object implements Serializable

serialVersionUID: -1706025148098445175L

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
                        ClassNotFoundException
Handles object inflation.

Throws:
IOException
ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException
Handles object serialization

Throws:
IOException - if the loader is still doing discovery.
Serialized Fields

store

Store store
The data store to be used to hold the DTS.


cache

Cache cache
The cache to use when discovering XML materials specified as a String rather than just via a URI that resolves to the required XML.


xlinkProcessor

XLinkProcessor xlinkProcessor
The Xlink processor


entityResolver

EntityResolver entityResolver
The entity resolver to use for resolution of entities (URIs etc) during the loading/discovery process.


documentQueue

TreeSet<E> documentQueue
The queue of documents remaining to load.


history

History history
The document history recording system used to track the documents being loaded, their URIs and their document identifiers. This defaults to a simple one that does basic logging.


useSchemaLocationAttributes

boolean useSchemaLocationAttributes

Package org.xbrlapi.networks

Class org.xbrlapi.networks.AllAnalyserImpl extends AnalyserImpl implements Serializable

serialVersionUID: 1925689384507981684L

Class org.xbrlapi.networks.AnalyserImpl extends Object implements Serializable

serialVersionUID: -3842008045278037807L

Serialized Fields

store

Store store

Class org.xbrlapi.networks.EquivalentRelationshipsImpl extends Object implements Serializable

serialVersionUID: 5470514499342023524L

Serialized Fields

relationships

SortedMap<K,V> relationships

Class org.xbrlapi.networks.NetworkImpl extends Object implements Serializable

serialVersionUID: 7587744792648107666L

Serialized Fields

linkRole

URI linkRole
The link role for the network.


arcRole

URI arcRole
The arcrole for the network.


store

Store store
The data store to retrieve fragments if they are not already retrieved.


relationships

Set<E> relationships

fragments

HashMap<K,V> fragments
The map of fragments involved in the relationships in the network.


sourceRelationships

HashMap<K,V> sourceRelationships
The map from sources to relationships. The maps are indexed first by the source fragment index and then by the semantic key for the relationship.


targetRelationships

HashMap<K,V> targetRelationships
The map from targets to relationships. The maps are indexed first by the target fragment index and then by the semantic key for the relationship.

Class org.xbrlapi.networks.NetworksImpl extends Object implements Serializable

serialVersionUID: -2248000947521760765L

Serialized Fields

arcs

HashMap<K,V> arcs

store

Store store
The data store containing the information defining the networks.


networks

HashMap<K,V> networks

Class org.xbrlapi.networks.NonProhibitedAnalyserImpl extends AnalyserImpl implements Serializable

serialVersionUID: -4136715748794742559L


Package org.xbrlapi.sax

Class org.xbrlapi.sax.EntityResolverImpl extends Object implements Serializable

serialVersionUID: -4898895229134572933L

Serialized Fields

cache

Cache cache
The local document cache.


Package org.xbrlapi.utilities

Class org.xbrlapi.utilities.XBRLException extends Exception implements Serializable

serialVersionUID: 9071731735229812074L

Serialized Fields

cause

Throwable cause

Package org.xbrlapi.xdt

Class org.xbrlapi.xdt.CustomLinkRecogniserImpl extends XBRLCustomLinkRecogniserImpl implements Serializable

serialVersionUID: 6126089270751428220L

Class org.xbrlapi.xdt.DimensionImpl extends XDTConceptImpl implements Serializable

serialVersionUID: -1980428745071603911L

Class org.xbrlapi.xdt.ExplicitDimensionImpl extends DimensionImpl implements Serializable

serialVersionUID: -1286219707900264040L

Class org.xbrlapi.xdt.HypercubeImpl extends XDTConceptImpl implements Serializable

serialVersionUID: -3395259164875316193L

Class org.xbrlapi.xdt.LoaderImpl extends LoaderImpl implements Serializable

serialVersionUID: -3038834547504590432L

Serialization Methods

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException
Handles object serialization

Throws:
IOException

Class org.xbrlapi.xdt.TypedDimensionImpl extends DimensionImpl implements Serializable

serialVersionUID: 5438651870246061004L

Class org.xbrlapi.xdt.XDTConceptImpl extends ConceptImpl implements Serializable

serialVersionUID: -7286523220608634863L

Class org.xbrlapi.xdt.XLinkHandlerImpl extends XBRLXLinkHandlerImpl implements Serializable

serialVersionUID: -4285395768000453609L


Package org.xbrlapi.xdt.aspects

Class org.xbrlapi.xdt.aspects.DimensionalAspectModelImpl extends AspectModelImpl implements Serializable

serialVersionUID: -525899452312079180L

Class org.xbrlapi.xdt.aspects.DimensionalAspectModelWithMemoryCachingLabellers extends DimensionalAspectModelImpl implements Serializable

serialVersionUID: 5698921583875791928L

Class org.xbrlapi.xdt.aspects.DimensionalAspectModelWithStoreCachingLabellers extends DimensionalAspectModelImpl implements Serializable

serialVersionUID: 1324422842628544753L

Class org.xbrlapi.xdt.aspects.DimensionAspect extends AspectImpl implements Serializable

serialVersionUID: -1064727564185247805L

Serialized Fields

dimensionNamespace

URI dimensionNamespace
The namespace of this dimension.


dimensionLocalname

String dimensionLocalname
The local name of this dimension.

Class org.xbrlapi.xdt.aspects.DimensionDomainImpl extends DomainImpl implements Serializable

serialVersionUID: 3554939207956749455L

Serialized Fields

dimensionNamespace

URI dimensionNamespace
The namespace of the relevant explicit dimension.


dimensionLocalname

String dimensionLocalname
The local name of the relevant explicit dimension.

Class org.xbrlapi.xdt.aspects.ExplicitDimensionAspect extends DimensionAspect implements Serializable

serialVersionUID: 1229327071811330083L

Serialized Fields

defaultValue

ExplicitDimensionAspectValue defaultValue

Class org.xbrlapi.xdt.aspects.ExplicitDimensionAspectValue extends AspectValueImpl implements Serializable

serialVersionUID: -6980141374852428096L

Serialized Fields

aspectId

URI aspectId
The aspect ID.


namespace

URI namespace
The URI namespace of the member.


localName

String localName
The local name of the member.

Class org.xbrlapi.xdt.aspects.ExplicitDimensionDomain extends DimensionDomainImpl implements Serializable

serialVersionUID: -7899272108800279347L

Class org.xbrlapi.xdt.aspects.ExplicitDimensionLabeller extends BaseLabeller implements Serializable

serialVersionUID: -2179477289946077839L

Class org.xbrlapi.xdt.aspects.ScenarioRemainderAspect extends AspectImpl implements Serializable

serialVersionUID: -6218851432259892401L

Class org.xbrlapi.xdt.aspects.ScenarioRemainderAspectValue extends AspectValueImpl implements Serializable

serialVersionUID: 7618757738645441910L

Serialized Fields

children

List<E> children
The list of child elements of the segment or null if the segment aspect value is missing.


id

String id
The missing aspect value ID is the empty string.

See Also:
AspectValue.getId()

Class org.xbrlapi.xdt.aspects.ScenarioRemainderDomain extends DomainImpl implements Serializable

serialVersionUID: -3331042977037158753L

Class org.xbrlapi.xdt.aspects.ScenarioRemainderLabeller extends BaseLabeller implements Serializable

serialVersionUID: -3690456459667430825L

Class org.xbrlapi.xdt.aspects.SegmentRemainderAspect extends AspectImpl implements Serializable

serialVersionUID: 1204517671744178026L

Class org.xbrlapi.xdt.aspects.SegmentRemainderAspectValue extends AspectValueImpl implements Serializable

serialVersionUID: 1062273129365066675L

Serialized Fields

children

List<E> children
The list of child elements of the segment or null if the segment aspect value is missing.


id

String id
The missing aspect value ID is the empty string.

See Also:
AspectValue.getId()

Class org.xbrlapi.xdt.aspects.SegmentRemainderDomain extends DomainImpl implements Serializable

serialVersionUID: -6711700785488055575L

Class org.xbrlapi.xdt.aspects.SegmentRemainderLabeller extends BaseLabeller implements Serializable

serialVersionUID: -3690456459667430825L

Class org.xbrlapi.xdt.aspects.TypedDimensionAspect extends DimensionAspect implements Serializable

serialVersionUID: 5810844872183326245L

Class org.xbrlapi.xdt.aspects.TypedDimensionAspectValue extends AspectValueImpl implements Serializable

serialVersionUID: -9066792364652801758L

Serialized Fields

aspectId

URI aspectId
The aspect ID.


children

List<E> children
The list of child element and text nodes of the typed dimension value container.

Class org.xbrlapi.xdt.aspects.TypedDimensionDomain extends DimensionDomainImpl implements Serializable

serialVersionUID: 7609975616855275437L

Class org.xbrlapi.xdt.aspects.TypedDimensionLabeller extends BaseLabeller implements Serializable

serialVersionUID: 3050503522357576606L


Package org.xbrlapi.xdt.validation

Class org.xbrlapi.xdt.validation.XDTAnalyser extends Object implements Serializable

serialVersionUID: -5684731124197015160L


Package org.xbrlapi.xlink

Class org.xbrlapi.xlink.CustomLinkRecogniser extends Object implements Serializable

serialVersionUID: 5541842174210812036L

Serialized Fields

thing

String thing

Class org.xbrlapi.xlink.Validator extends XLinkHandlerDefaultImpl implements Serializable

serialVersionUID: 3959551538061351755L

Serialized Fields

is

InputSource is
The input source to be XLink validated


xlinkProcessor

XLinkProcessor xlinkProcessor
The XLink processor


document

Document document
XML DOM document used to capture the error messages

Class org.xbrlapi.xlink.XLinkException extends Exception implements Serializable

serialVersionUID: 6594154185788570002L

Serialized Fields

cause

Throwable cause

Class org.xbrlapi.xlink.XLinkHandlerDefaultImpl extends Object implements Serializable

serialVersionUID: -6060131708671079013L

Class org.xbrlapi.xlink.XLinkProcessorImpl extends Object implements Serializable

serialVersionUID: 5455130402128320301L

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
                        ClassNotFoundException
Handles object inflation.

Throws:
IOException
ClassNotFoundException
Serialized Fields

xlinkHandler

XLinkHandler xlinkHandler
The XLink handler to use for responding to XLink events in the SAX parsing process.


customLinkRecogniser

CustomLinkRecogniser customLinkRecogniser
The Custom Link Recogniser, to be used for simple link syntaxes that are not specified by the XLink specification but need to be processed by the XLink processor. Set to null by default for cases where no non-XLink syntax needs to be treated as a link.


Package org.xbrlapi.xlink.handler

Class org.xbrlapi.xlink.handler.XBRLCustomLinkRecogniserImpl extends CustomLinkRecogniser implements Serializable

serialVersionUID: 5149996620311673778L

Class org.xbrlapi.xlink.handler.XBRLXLinkHandlerImpl extends XLinkHandlerDefaultImpl implements Serializable

serialVersionUID: -2936024797284955596L

Serialized Fields

loader

Loader loader
The XBRL DTS loader that is using this XLink handler


baseURIResolver

BaseURISAXResolver baseURIResolver
The base URI resolver used by the XLink handler


Package org.xbrlapi.xmlbase

Class org.xbrlapi.xmlbase.BaseURIDOMResolverImpl extends BaseURIResolverImpl implements Serializable

serialVersionUID: 8478951714108359135L

Class org.xbrlapi.xmlbase.BaseURIResolverImpl extends Object implements Serializable

serialVersionUID: -6443122097068406301L

Class org.xbrlapi.xmlbase.BaseURISAXResolverImpl extends BaseURIResolverImpl implements Serializable

serialVersionUID: -3463357951277162491L

Class org.xbrlapi.xmlbase.XMLBaseException extends Exception implements Serializable

serialVersionUID: -6062388656987869506L

Serialized Fields

cause

Throwable cause

Package org.xbrlapi.xpointer

Class org.xbrlapi.xpointer.ParseException extends Exception implements Serializable

serialVersionUID: -8639759776456618868L

Serialized Fields

specialConstructor

boolean specialConstructor
This variable determines which constructor was used to create this object and thereby affects the semantics of the "getMessage" method (see below).


currentToken

Token currentToken
This is the last token that has been consumed successfully. If this object has been created due to a parse error, the token followng this token will (therefore) be the first error token.


expectedTokenSequences

int[][] expectedTokenSequences
Each entry in this array is an array of integers. Each array of integers represents a sequence of tokens (by their ordinal values) that is expected at this point of the parse.


tokenImage

String[] tokenImage
This is a reference to the "tokenImage" array of the generated parser within which the parse error occurred. This array is defined in the generated ...Constants interface.


eol

String eol
The end of line string for this machine.

Class org.xbrlapi.xpointer.TokenMgrError extends Error implements Serializable

serialVersionUID: 6546660364436352091L

Serialized Fields

errorCode

int errorCode
Indicates the reason why the exception is thrown. It will have one of the above 4 values.


Get Java XBRL API implementation at SourceForge.net.