com.ihr.xbrl.om.exLinks

Interface XBRLRelationshipPoint

All Known Implementing Classes:

AutoFill, BaseElem, BaseIXDenominator, BaseIXElement, BaseIXExclude, BaseIXFact, BaseIXFactItem, BaseIXFactNumeric, BaseIXFootnote, BaseIXFraction, BaseIXHeader, BaseIXHidden, BaseIXNonFraction, BaseIXNonNumeric, BaseIXNumerator, BaseIXReferences, BaseIXRelationship, BaseIXResources, BaseIXTuple, CalculationLinkbase, CustomCode, DefinitionLinkbase, ElemA, ElemAbbr, ElemAcronym, ElemAddress, ElemArea, ElemB, ElemBase, ElemBdo, ElemBig, ElemBlockquote, ElemBody, ElemBr, ElemButton, ElemCaption, ElemCite, ElemCode, ElemCol, ElemColgroup, ElemDd, ElemDel, ElemDfn, ElemDiv, ElemDl, ElemDt, ElemEm, ElemFieldset, ElemForm, ElemH1, ElemH2, ElemH3, ElemH4, ElemH5, ElemH6, ElemHead, ElemHr, ElemHtml, ElemI, ElemImg, ElemInput, ElemIns, ElemKbd, ElemLabel, ElemLegend, ElemLi, ElemLink, ElemMap, ElemMeta, ElemNoscript, ElemObject, ElemOl, ElemOptgroup, ElemOption, ElemP, ElemParam, ElemPre, ElemQ, ElemRb, ElemRp, ElemRt, ElemRuby, ElemSamp, ElemScript, ElemSelect, ElemSmall, ElemSpan, ElemStrong, ElemStyle, ElemSub, ElemSup, ElemTable, ElemTbody, ElemTd, ElemTextarea, ElemTfoot, ElemTh, ElemThead, ElemTitle, ElemTr, ElemTt, ElemUl, ElemVar, FlMessage, FootnoteLinkbase, FormulaLinkbase, GenericLinkbase, IX10Denominator, IX10Exclude, IX10Footnote, IX10Fraction, IX10Header, IX10Hidden, IX10NonFraction, IX10NonNumeric, IX10Numerator, IX10References, IX10Resources, IX10Tuple, IX11Continuation, IX11Denominator, IX11Exclude, IX11Footnote, IX11Fraction, IX11Header, IX11Hidden, IX11NonFraction, IX11NonNumeric, IX11Numerator, IX11References, IX11Relationship, IX11Resources, IX11Tuple, LabelLinkbase, MapperAnchor, MapperCompany, MapperContext, MapperContextBase, MapperContexts, MapperDataSources, MapperDocumentation, MapperDts, MapperFact, MapperFacts, MapperFile, MapperInstance, MapperPeriod3, MapperPeriodBase, MapperRootNode, MapperScheme, MapperSection, MapperSource, MapperUnits, OtherLinkbase, PresentationLinkbase, ReferenceLinkbase, RenderHints, RSTableAction, RSTableEvaluableResource, RSTableOpenFilter, StaticRole, VersionLinkbase, XBRLAncestorFilter, XBRLAndFilter, XBRLArc, XBRLArcroleRef, XBRLArcroleType, XBRLAspectCoverFilter, XBRLAspectNode, XBRLAssertion, XBRLBreakdown, XBRLClosedDefinitionNode, XBRLConceptBalanceFilter, XBRLConceptCustomAttributeFilter, XBRLConceptDataTypeFilter, XBRLConceptFilterAbstract, XBRLConceptNameFilter, XBRLConceptPeriodTypeFilter, XBRLConceptRelationFilter, XBRLConceptRelationshipNode, XBRLConceptSubstitutionGroupFilter, XBRLConsistencyAssertion, XBRLContext, XBRLCustomFunction, XBRLCustomFunctionImplementation, XBRLDefinition, XBRLDefinitionNode, XBRLDimensionFilterAbstract, XBRLDimensionRelationshipNode, XBRLDimensionsContainer, XBRLDocumentation, XBRLDocumentRootNode, XBRLElementDefinition, XBRLEntity, XBRLExistenceAssertion, XBRLExplicitDimensionFilter, XBRLExtendedLink, XBRLFact, XBRLFactItem, XBRLFactNonNumeric, XBRLFactNumeric, XBRLFactTuple, XBRLFormula, XBRLFormulaFilterBase, XBRLFormulaResource, XBRLGeneralFilter, XBRLGeneralMeasuresFilter, XBRLIdentifier, XBRLIdentifierFilter, XBRLImport, XBRLInclude, XBRLInstanceRootNode, XBRLItem, XBRLLabelResource, XBRLLinkbaseRef, XBRLLinkbaseRootNode, XBRLLocationFilter, XBRLLocator, XBRLMatchAbstractFilter, XBRLMatchConceptFilter, XBRLMatchDimensionFilter, XBRLMatchEntityIdentifierFilter, XBRLMatchLocationFilter, XBRLMatchNonXDTScenarioFilter, XBRLMatchNonXDTSegmentFilter, XBRLMatchPeriodFilter, XBRLMatchScenarioFilter, XBRLMatchSegmentFilter, XBRLMatchUnitFilter, XBRLMeasure, XBRLOpenDefinitionNode, XBRLOrFilter, XBRLParentFilter, XBRLPeriod, XBRLPeriodEndFilter, XBRLPeriodFilter, XBRLPeriodFilterAbstract, XBRLPeriodForeverFilter, XBRLPeriodInstantDurationFilter, XBRLPeriodInstantFilter, XBRLPeriodStartFilter, XBRLPointerOfARelationship, XBRLRegExpIdentifierFilter, XBRLRegExpSchemeFilter, XBRLRelationship, XBRLRelationshipNode, XBRLRelationshipPointImpl, XBRLRelativeFilter, XBRLResource, XBRLResultMessage, XBRLRoleAndArcroleTypes, XBRLRoleRef, XBRLRoleType, XBRLRuleNode, XBRLScenario, XBRLScenarioFilter, XBRLSchemaRef, XBRLSegment, XBRLSegmentFilter, XBRLSiblingFilter, XBRLSimpleLink, XBRLSingleMeasureFilter, XBRLSpecificIdentifierFilter, XBRLSpecificSchemeFilter, XBRLTable, XBRLTableResource, XBRLTaxonomyRootNode, XBRLTuple, XBRLTypedDimensionFilter, XBRLUnit, XBRLUsedOn, XBRLValueAssertion, XBRLValueNilFilter, XBRLValuePrecisionFilter, XBRLVariableEqualityDefinition, XBRLVariableFact, XBRLVariableGeneral, XBRLVariableParameter, XBRLVariablePrecondition, XBRLVariableResource, XBRLVariableSetResource, XLinkElement, XMLAnnotation, XMLAppInfo, XMLElementDefinition, XMLFragment

public interface XBRLRelationshipPoint

Elements that are extreme of a relationship in the source or target pointer MUST implement this interface .

Author:

Ignacio

Method Summary

Modifier and Type	Method and Description
boolean	addFromRelationship(XBRLRelationship rel) Adds the from relationship.
boolean	addToRelationship(XBRLRelationship rel) Adds the to relationship.
java.util.Iterator<XBRLRelationship>	getFromRelationships() Returns the relationship objects that contains this element in the source of the relationship.
java.util.Iterator<XBRLRelationship>	getFromRelationships(int arcrole) Obtains an iterator over all relationships where this fragment is the source of the relationship and the arcrole corresponds to the parameter indicated.
java.util.Iterator<XBRLRelationship>	getFromRelationships(int arcrole, DTSBase base) Gets the from relationships.
java.util.Iterator<XBRLRelationship>	getFromRelationships(XBRLArcroleType arcrole) Obtains an iterator over all relationships where this fragment is the source of the relationship and the arcrole corresponds to the parameter indicated.
java.util.Iterator<XBRLRelationship>	getFromRelationships(XBRLArcroleType arcrole, DTSBase base) Gets the from relationships.
int	getNumberOfFromRelationships() Returns the number of relationships this fragment is in its source.
int	getNumberOfToRelationships() Returns the number of relationships this fragment is in its target.
java.util.Iterator<DTSBase>	getRelationshipsBases() Returns an iterator over all DTSBases this object has relationships from.
java.util.Iterator<XBRLRelationshipsChainLink>	getRelationshipsChain(DTSBase base, javax.xml.namespace.QName type) Process all relationships this item is source and returns an iterator over all XBRLRelationshipsChainLink(s).
java.util.Iterator<javax.xml.namespace.QName>	getRelationshipTypes(DTSBase base) Returns an iterator over all QNames of relationship types that exists in a specific base.
java.util.Iterator<XBRLRelationship>	getToRelationships() Returns the relationship objects that contains this element in the target of the relationship.
java.util.Iterator<XBRLRelationship>	getToRelationships(int arcrole) Obtains an iterator over all relationships where this fragment is the target of the relationship and the arcrole corresponds to the parameter indicated.
java.util.Iterator<XBRLRelationship>	getToRelationships(int arcrole, DTSBase base) Gets the to relationships.
java.util.Iterator<XBRLRelationship>	getToRelationships(XBRLArcroleType arcrole) Obtains an iterator over all relationships where this fragment is the target of the relationship and the arcrole corresponds to the parameter indicated.
java.util.Iterator<XBRLRelationship>	getToRelationships(XBRLArcroleType arcrole, DTSBase base) Gets the to relationships.
boolean	removeFromRelationship(XBRLRelationship rel) Removes the from relationship.
boolean	removeToRelationship(XBRLRelationship rel) Removes the to relationship.

Method Detail

addFromRelationship

boolean addFromRelationship(XBRLRelationship rel)
                     throws XBRLInconsistentDTSException

Adds the from relationship.

Parameters:

rel - the rel

Returns:

true, if successful

Throws:

XBRLInconsistentDTSException - the XBRL inconsistent dts exception

addToRelationship

boolean addToRelationship(XBRLRelationship rel)
                   throws XBRLInconsistentDTSException

Adds the to relationship.

Parameters:

rel - the rel

Returns:

true, if successful

Throws:

XBRLInconsistentDTSException - the XBRL inconsistent dts exception

getFromRelationships

java.util.Iterator<XBRLRelationship> getFromRelationships(XBRLArcroleType arcrole,
                                                          DTSBase base)

Gets the from relationships.

Parameters:

arcrole - the arcrole

base - the base

Returns:

the from relationships

getFromRelationships

java.util.Iterator<XBRLRelationship> getFromRelationships(int arcrole,
                                                          DTSBase base)

Gets the from relationships.

Parameters:

arcrole - the arcrole code

base - the base

Returns:

the from relationships

Since:

3.2.0

getFromRelationships

java.util.Iterator<XBRLRelationship> getFromRelationships(XBRLArcroleType arcrole)

Obtains an iterator over all relationships where this fragment is the source of the relationship and the arcrole corresponds to the parameter indicated.

Parameters:

arcrole - XBRLArcroleType

Returns:

Iterator<XBRLRelationship>

Since:

2.6.5

getFromRelationships

java.util.Iterator<XBRLRelationship> getFromRelationships(int arcrole)

Obtains an iterator over all relationships where this fragment is the source of the relationship and the arcrole corresponds to the parameter indicated.

Parameters:

arcrole - XBRLArcroleType code

Returns:

Iterator<XBRLRelationship>

Since:

3.2.0

getFromRelationships

java.util.Iterator<XBRLRelationship> getFromRelationships()

Returns the relationship objects that contains this element in the source of the relationship.

Returns:

Iterator<XBRLRelationship>

getNumberOfFromRelationships

int getNumberOfFromRelationships()

Returns the number of relationships this fragment is in its source.

Returns:

int

getToRelationships

java.util.Iterator<XBRLRelationship> getToRelationships(XBRLArcroleType arcrole,
                                                        DTSBase base)

Gets the to relationships.

Parameters:

arcrole - the arcrole

base - the base

Returns:

the to relationships

getToRelationships

java.util.Iterator<XBRLRelationship> getToRelationships(int arcrole,
                                                        DTSBase base)

Gets the to relationships.

Parameters:

arcrole - the arcrole code

base - the base

Returns:

the to relationships

getToRelationships

java.util.Iterator<XBRLRelationship> getToRelationships(XBRLArcroleType arcrole)

Obtains an iterator over all relationships where this fragment is the target of the relationship and the arcrole corresponds to the parameter indicated.

Parameters:

arcrole - XBRLArcroleType

Returns:

Iterator<XBRLRelationship>

Since:

2.6.5

getToRelationships

java.util.Iterator<XBRLRelationship> getToRelationships(int arcrole)

Obtains an iterator over all relationships where this fragment is the target of the relationship and the arcrole corresponds to the parameter indicated.

Parameters:

arcrole - XBRLArcroleType code

Returns:

Iterator<XBRLRelationship>

Since:

2.6.5

getToRelationships

java.util.Iterator<XBRLRelationship> getToRelationships()

Returns the relationship objects that contains this element in the target of the relationship.

Returns:

the to relationships

getNumberOfToRelationships

int getNumberOfToRelationships()

Returns the number of relationships this fragment is in its target.

Returns:

the number of to relationships

removeFromRelationship

boolean removeFromRelationship(XBRLRelationship rel)
                        throws XBRLInconsistentDTSException

Removes the from relationship.

Parameters:

rel - the rel

Returns:

true, if successful

Throws:

XBRLInconsistentDTSException - the XBRL inconsistent dts exception

removeToRelationship

boolean removeToRelationship(XBRLRelationship rel)
                      throws XBRLInconsistentDTSException

Removes the to relationship.

Parameters:

rel - the rel

Returns:

true, if successful

Throws:

XBRLInconsistentDTSException - the XBRL inconsistent dts exception

getRelationshipsBases

java.util.Iterator<DTSBase> getRelationshipsBases()
                                           throws XBRLValidationException

Returns an iterator over all DTSBases this object has relationships from.

Returns:

the relationships bases

Throws:

XBRLValidationException - the XBRL validation exception

getRelationshipTypes

java.util.Iterator<javax.xml.namespace.QName> getRelationshipTypes(DTSBase base)
                                                            throws XBRLValidationException

Returns an iterator over all QNames of relationship types that exists in a specific base.

Parameters:

base - the base

Returns:

Iterator<QName>

Throws:

XBRLValidationException - the XBRL validation exception

getRelationshipsChain

java.util.Iterator<XBRLRelationshipsChainLink> getRelationshipsChain(DTSBase base,
                                                                     javax.xml.namespace.QName type)

Process all relationships this item is source and returns an iterator over all XBRLRelationshipsChainLink(s).

Parameters:

base - the base

type - the type

Returns:

Iterator<XBRLRelationshipsChainLink>