IdKeeper

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.batavia.xml
Interface IdKeeper

All Known Subinterfaces:: All, Annotation, AnyAttribute, AnyElement, AppInfo, Arc, ArcroleRef, ArcroleType, AttributeGroup, AttributeType, BasicType, CalculationArc, CalculationLink, Choice, ComplexContent, ComplexType, Concept, Context, ContextElement, DateTime, Declaration, DeclaredArc, DeclaredLink, DeclaredResource, Definition, DefinitionArc, DefinitionLink, DimensionalContext, DimensionalFractionItem, DimensionalItem, DimensionalMember, DimensionalScenario, DimensionalSegment, Divide, Documentation, Documentation, EndDate, Entity, ExplicitMember, ExtendedLink, Extension, ExtensionType, Fact, Footnote, FootnoteArc, FootnoteLink, FootnoteLocator, Forever, Fraction, FractionDenominator, FractionItemType, FractionNumerator, FractionPart, Group, GroupRefElement, Identifier, Import, Include, InstanceElement, Instant, Item, Item, Label, LabelArc, Labelled, LabelLink, Linkbase, LinkbaseExtendedLink, LinkbaseRef, LinkbaseRef, LinkbaseRoot, LinkElement, Locator, Measure, MessageElement, MessagesElement, OriginElement, Part, Period, PresentationArc, PresentationLink, Redefine, RefElement, Reference, ReferenceArc, ReferenceLink, RegularInstanceElement, RegularSchemaElement, RelationLink, ReportScope, Resource, Restriction, RestrictionElement, RoleRef, RoleType, RoleTypeElement, Root, RootElement, Scenario, SchemaRef, Segment, Sequence, SimpleContent, SimpleLink, SimpleType, StartDate, TaxonomyElement, Title, Tuple, Tuple, TypedMember, Unit, UnitDenominator, UnitElement, UnitNumerator, UnknownInstanceElement, UnknownTaxonomyElement, UnknownXlink, UsedOn, Xbrl, XbrlElement, XbrlType, Xlink, XmlElement

public interface IdKeeper

Interface for all classes that manage idholders.

No duplicate ids allowed! IdHolders that are added while the id is already present will replace the present IdHolder. There is no indication for the caller that this has occured. Re-using the same ids in relation to the same IdKeeper will result in lost IdHolders.

If you want you can use a Set in Map implementation to preserve older IdHolders.

Part of Licensed Materials.

www.batavia-xbrl.com

Author:: Ron van Ardenne

Method Summary
`void`	`addIdHolder(IdHolder idHolder)` Add the IdHolder to a collection in such a manner that it will be available on request by its id.
`IdHolder`	`getHolder(java.lang.String id)` Get the IdHolder from a collection when it was made available in advance by a call to the same objects addIdHolder(idHolder) method.
`XmlElement`	`getPointedElement(java.lang.String xpointer)` Get the XbrlElementImpl from the collection of children and their children based on the xpointer value.
`void`	`removeIdHolder(IdHolder idHolder)`

Method Detail

addIdHolder

void addIdHolder(IdHolder idHolder)

Add the IdHolder to a collection in such a manner that it will be available on request by its id.

Parameters:: idHolder - IdHolder that has to be added.

getHolder

IdHolder getHolder(java.lang.String id)

Get the IdHolder from a collection when it was made available in advance by a call to the same objects addIdHolder(idHolder) method.

Parameters:: id - Id XmlAttributeImpl value.

getPointedElement

XmlElement getPointedElement(java.lang.String xpointer)

Get the XbrlElementImpl from the collection of children and their children based on the xpointer value. The xpointer will be a sequence of child Ids and/or child sequencenrs separated by forward slashes (/).

Parameters:: xpointer - value.

removeIdHolder

void removeIdHolder(IdHolder idHolder)