## Uses of Class
com.ihr.xbrl.om.exLinks.XBRLRelationship

- Packages that use XBRLRelationship
  Package | Description
  --- | ---
  com.ihr.xbrl.adins.efm.errors | Provides classes for the specific error messages for the the implementation of the Edgar Filer Manual validation add-in This package is part of the implementation of the Edgar Filer Manual
  com.ihr.xbrl.dts | Provides the classes necessary to investigate the content of a DTS.
  com.ihr.xbrl.om | Provides the classes necessary to start processing XBRL information.
  com.ihr.xbrl.om.errors | Provides the classes necessary to produce and process XBRL related errors There are two error categories.
  com.ihr.xbrl.om.exLinks | Provides the classes necessary to process, read and write XBRL Linkbases and XBRL Extended links.
  com.ihr.xbrl.om.formula | Provides the classes necessary to implement a plug in XBRL processor for validation of docuents and taxonomies according to the XBRL formula specification 1.0 At this stage the package is just created.
  com.ihr.xbrl.om.formula.functions.reusable | Contains classes than can be reused from XFI functions and other classes in the API that requires the same functionality but without the overhead of being an XFI function with parameters
  com.ihr.xbrl.om.table | This package contains an object model to work with tables as defined in the XBRL Table specification The current implementation is based on table linkbase PWD http://www.xbrl.org/Specification/table-linkbase/PWD-2013-05-17/table-linkbase-PWD-2013-05-17.html The XBRLTableProcessor class
  com.ihr.xbrl.om.table.definition | Classes supporting definition nodes
  com.ihr.xbrl.om.taxonomy | Provides the classes necessary to process, write and read XBRL Taxonomy schemas and content of the XBRL Taxonomy Schemas that requires XBRL processing.
  com.ihr.xbrl.om.xdt | Provides the classes necessary to implement a plug in XBRL processor for validation of dimensional instance documents according to the XBRL Dimensions specification 1.0 This package contains two hierarchies of classes.
  com.ihr.xbrl.pojo | Provides the classes necessary to access to the content of a DTS using POJO technology.

- - ### Uses of XBRLRelationship in com.ihr.xbrl.adins.efm.errors

    Constructors in com.ihr.xbrl.adins.efm.errors with parameters of type XBRLRelationship
    Constructor and Description
    `EFMCalculationPeriodTypeMismatch(XBRLRelationship rel)` Instantiates a new EFM calculation period type mismatch.
    `EFMInvalidArcroleOnFootnoreArc(XBRLRelationship rel)` Instantiates a new EFM invalid arcrole on footnore arc.
    `EFMInvalidRelationshipOrderAttribute(XBRLRelationship rel)` Instantiates a new EFM invalid relationship order attribute.
    `EFMNetativeTableWithoutPositiveTableFound(XBRLRelationship rel, java.lang.String uri)` Instantiates a new EFM netative table without positive table found.
    `EFMNoConsecutiveRelationship(XBRLRelationship rel, java.lang.String uri, java.lang.String uri2)` Instantiates a new EFM no consecutive relationship.
    `EFMNotAllMustHaveClosedTrue(XBRLRelationship rel)` Instantiates a new EFM not all must have closed true.

    Constructor parameters in com.ihr.xbrl.adins.efm.errors with type arguments of type XBRLRelationship
    Constructor and Description
    `EFMNetativeTableWithoutPositiveTableFound(java.util.ArrayList<XBRLRelationship> list)` Instantiates a new EFM netative table without positive table found.

  - ### Uses of XBRLRelationship in com.ihr.xbrl.dts

    Methods in com.ihr.xbrl.dts that return XBRLRelationship
    Modifier and Type | Method and Description
    --- | ---
    `XBRLRelationship` | XBRLTreeWalker.`getRelationship()` Gets the relationship.

    Methods in com.ihr.xbrl.dts with parameters of type XBRLRelationship
    Modifier and Type | Method and Description
    --- | ---
    `void` | PMember.`buildDomain(XBRLRelationship rel)` Builds the domain.

    Constructors in com.ihr.xbrl.dts with parameters of type XBRLRelationship
    Constructor and Description
    `PMember(XMLElementDefinition item, XBRLRelationship rel, Dimension<?> dim)` Instantiates a new p member.
    `XBRLTreeWalker(XBRLRelationship rel)` Instantiates a new XBRL tree walker.

  - ### Uses of XBRLRelationship in com.ihr.xbrl.om

    Fields in com.ihr.xbrl.om with type parameters of type XBRLRelationship
    Modifier and Type | Field and Description
    --- | ---
    `static EmptyIterator<XBRLRelationship>` | XMLFragment.`EMPTYRELATIONSHIPSITERATORINSTANCE` Implements an empty Iterator over relationships returned when there are no relationships to iterate over.
    `static java.util.Comparator<XBRLRelationship>` | XMLFragment.`OrderComparator` class to compare two relationships based on the value of the order attribute and order a set of arcs accordingly.
    `static java.util.Comparator<XBRLRelationship>` | XMLFragment.`OrderComparator2` class to compare two relationships based on the value of the order attribute and order a set of arcs accordingly.

    Methods in com.ihr.xbrl.om that return XBRLRelationship
    Modifier and Type | Method and Description
    --- | ---
    `XBRLRelationship` | DTSContainer.`getRelationship(java.lang.String extendedLink, javax.xml.namespace.QName relationshipType, java.lang.String arcrole, java.util.Vector<XMLFragment> attributes, XMLFragment source, XMLFragment target)` Returns the relationship that matches the search criteria.

    Methods in com.ihr.xbrl.om that return types with arguments of type XBRLRelationship
    Modifier and Type | Method and Description
    --- | ---
    `java.util.Iterator<XBRLRelationship>` | XMLFragment.`getFromRelationships()` Returns the relationship objects that contains this element in the source of the relationship.
    `java.util.Iterator<XBRLRelationship>` | XMLFragment.`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.Collection<XBRLRelationship>` | XMLFragment.`getFromRelationships(XBRLArcroleType arcrole, java.util.Comparator<XBRLRelationship> comparator)` Returns a collection of relationship objects that contains this element in the source of the relationship using a filter on the arcrole value regardless the base set the relationship belongs to.
    `java.util.Iterator<XBRLRelationship>` | XMLFragment.`getFromRelationships(XBRLArcroleType arcrole, DTSBase base)` Returns the relationship objects that contains this element in the source of the relationship using a filter on the arcrole value.
    `java.util.Collection<XBRLRelationship>` | XMLFragment.`getFromRelationships(XBRLArcroleType arcrole, DTSBase base, java.util.Comparator<XBRLRelationship> comparator)` Returns a collection of relationship objects that contains this element in the source of the relationship using a filter on the arcrole value and that belongs to a specific base.
    `java.util.Iterator<XBRLRelationship>` | DTSContainer.`getRelationships(DTSBase base)` Return all relationships in a DTSBase.
    `java.util.Iterator<XBRLRelationship>` | XMLFragment.`getToRelationships()` Returns the relationship objects that contains this element in the target of the relationship.
    `java.util.Iterator<XBRLRelationship>` | XMLFragment.`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.Collection<XBRLRelationship>` | XMLFragment.`getToRelationships(XBRLArcroleType arcrole, java.util.Comparator<XBRLRelationship> comparator)` Returns a collection of relationship objects that contains this element in the target of the relationship using a filter on the arcrole value regardless the base set the relationship belongs to.
    `java.util.Iterator<XBRLRelationship>` | XMLFragment.`getToRelationships(XBRLArcroleType arcrole, DTSBase base)` Returns the relationship objects that contains this element in the target of the relationship or null if there is none.
    `java.util.Collection<XBRLRelationship>` | XMLFragment.`getToRelationships(XBRLArcroleType arcrole, DTSBase base, java.util.Comparator<XBRLRelationship> comparator)` Returns a collection of relationship objects that contains this element in the target of the relationship using a filter on the arcrole value and that belongs to a specific base.

    Methods in com.ihr.xbrl.om with parameters of type XBRLRelationship
    Modifier and Type | Method and Description
    --- | ---
    `void` | XMLFragment.`addFromRelationship(XBRLRelationship rel)`
    `void` | XMLFragment.`addToRelationship(XBRLRelationship rel)`
    `void` | XMLFragment.`removeFromRelationship(XBRLRelationship rel)`
    `void` | XMLFragment.`removeToRelationship(XBRLRelationship rel)`

    Method parameters in com.ihr.xbrl.om with type arguments of type XBRLRelationship
    Modifier and Type | Method and Description
    --- | ---
    `java.util.Collection<XBRLRelationship>` | XMLFragment.`getFromRelationships(XBRLArcroleType arcrole, java.util.Comparator<XBRLRelationship> comparator)` Returns a collection of relationship objects that contains this element in the source of the relationship using a filter on the arcrole value regardless the base set the relationship belongs to.
    `java.util.Collection<XBRLRelationship>` | XMLFragment.`getFromRelationships(XBRLArcroleType arcrole, DTSBase base, java.util.Comparator<XBRLRelationship> comparator)` Returns a collection of relationship objects that contains this element in the source of the relationship using a filter on the arcrole value and that belongs to a specific base.
    `java.util.Collection<XBRLRelationship>` | XMLFragment.`getToRelationships(XBRLArcroleType arcrole, java.util.Comparator<XBRLRelationship> comparator)` Returns a collection of relationship objects that contains this element in the target of the relationship using a filter on the arcrole value regardless the base set the relationship belongs to.
    `java.util.Collection<XBRLRelationship>` | XMLFragment.`getToRelationships(XBRLArcroleType arcrole, DTSBase base, java.util.Comparator<XBRLRelationship> comparator)` Returns a collection of relationship objects that contains this element in the target of the relationship using a filter on the arcrole value and that belongs to a specific base.

  - ### Uses of XBRLRelationship in com.ihr.xbrl.om.errors

    Constructors in com.ihr.xbrl.om.errors with parameters of type XBRLRelationship
    Constructor and Description
    `XBRLInconsistencyCalculationPeriodTypeMismatch(XBRLRelationship rel)` Instantiates a new XBRL inconsistency calculation period type mismatch.
    `XBRLValidationExceptionArcroleRefTargetIsNotSchema(XBRLRelationship relationship, java.lang.String arcroleURI, java.lang.String href)` Instantiates a new XBRL validation exception arcrole ref target is not schema.
    `XBRLValidationExceptionConceptLabelSourceIsNotConcept(XBRLRelationship rel)` Instantiates a new XBRL validation exception concept label source is not concept.
    `XBRLValidationExceptionConceptLabelTargetIsNotLocalAndRelationshipIsNotProhibit(XBRLRelationship rel)` Instantiates a new XBRL validation exception concept label target is not local and relationship is not prohibit.
    `XBRLValidationExceptionConceptLabelTargetIsNotResource(XBRLRelationship rel)` Instantiates a new XBRL validation exception concept label target is not resource.
    `XBRLValidationExceptionConceptReferenceSourceIsNotConcept(XBRLRelationship rel)` Instantiates a new XBRL validation exception concept reference source is not concept.
    `XBRLValidationExceptionConceptReferenceTargetIsNotLocalAndRelationshipIsNotProhibit(XBRLRelationship rel)` Instantiates a new XBRL validation exception concept reference target is not local and relationship is not prohibit.
    `XBRLValidationExceptionConceptReferenceTargetIsNotResource(XBRLRelationship rel)` Instantiates a new XBRL validation exception concept reference target is not resource.
    `XBRLValidationExceptionEssenceAliasDifferentBalance(XBRLRelationship rel)` Instantiates a new XBRL validation exception essence alias different balance.
    `XBRLValidationExceptionEssenceAliasDifferentItemTypes(XBRLRelationship rel)` Instantiates a new XBRL validation exception essence alias different item types.
    `XBRLValidationExceptionEssenceAliasDifferentPeriodTypes(XBRLRelationship rel)` Instantiates a new XBRL validation exception essence alias different period types.
    `XBRLValidationExceptionEssenceAliasSourceNotItem(XBRLRelationship rel)` Instantiates a new XBRL validation exception essence alias source not item.
    `XBRLValidationExceptionEssenceAliasTargetNotItem(XBRLRelationship rel)` Instantiates a new XBRL validation exception essence alias target not item.
    `XBRLValidationExceptionFactFootnotearcSourceNotFact(XBRLRelationship rel)` Instantiates a new XBRL validation exception fact footnotearc source not fact.
    `XBRLValidationExceptionFactFootnotearcSourceOutOfInstanceScope(XBRLRelationship rel)` Instantiates a new XBRL validation exception fact footnotearc source out of instance scope.
    `XBRLValidationExceptionFactFootnotearcTargetNotResource(XBRLRelationship rel)` Instantiates a new XBRL validation exception fact footnotearc target not resource.
    `XBRLValidationExceptionFactFootnotearcTargetOutOfInstanceScope(XBRLRelationship rel)` Instantiates a new XBRL validation exception fact footnotearc target out of instance scope.
    `XBRLValidationExceptionGeneralSpecialSourceNotItem(XBRLRelationship rel)` Instantiates a new XBRL validation exception general special source not item.
    `XBRLValidationExceptionGeneralSpecialTargetNotItem(XBRLRelationship rel)` Instantiates a new XBRL validation exception general special target not item.
    `XBRLValidationExceptionInvalidDirectedCyclesFound(XBRLRelationship rel, java.util.Collection<XMLFragment> elements)` Instantiates a new XBRL validation exception invalid directed cycles found.
    `XBRLValidationExceptionInvalidUndirectedCyclesFound(XBRLRelationship rel, java.util.HashSet<XMLFragment> elements)` Instantiates a new XBRL validation exception invalid undirected cycles found.
    `XBRLValidationExceptionPreferredLabelLabelNotFound(XBRLRelationship rel, java.lang.String prefLabelRole)` Instantiates a new XBRL validation exception preferred label label not found.
    `XBRLValidationExceptionPreferredLabelRoleNotDefined(XBRLRelationship rel, java.lang.String prefLabelRole)` Instantiates a new XBRL validation exception preferred label role not defined.
    `XBRLValidationExceptionRequiresElementTargetNotFound(XBRLRelationship rel)` Instantiates a new XBRL validation exception requires element target not found.
    `XBRLValidationExceptionSummationItemInvalidCreditDebit(int subCode, XBRLRelationship rel)` Instantiates a new XBRL validation exception summation item invalid credit debit.
    `XBRLValidationExceptionSummationItemInvalidWeightValue(XBRLRelationship rel)` Instantiates a new XBRL validation exception summation item invalid weight value.
    `XBRLValidationExceptionSummationItemSourceNotItem(XBRLRelationship rel)` Instantiates a new XBRL validation exception summation item source not item.
    `XBRLValidationExceptionSummationItemSourceNotNumeric(XBRLRelationship rel)` Instantiates a new XBRL validation exception summation item source not numeric.
    `XBRLValidationExceptionSummationItemTargetNotItem(XBRLRelationship rel)` Instantiates a new XBRL validation exception summation item target not item.
    `XBRLValidationExceptionSummationItemTargetNotNumeric(XBRLRelationship rel)` Instantiates a new XBRL validation exception summation item target not numeric.

  - ### Uses of XBRLRelationship in com.ihr.xbrl.om.exLinks

    Methods in com.ihr.xbrl.om.exLinks that return types with arguments of type XBRLRelationship
    Modifier and Type | Method and Description
    --- | ---
    `java.util.Iterator<XBRLRelationship>` | DTSBase.`getBaseSetRelationshipsIterator(XBRLArcroleType arcrole)` Returns an iterator over the relationships in the base set.
    `java.util.Iterator<XBRLRelationship>` | DTSBase.`getBaseSetRelationshipsIterator(XBRLArcroleType arcrole, XBRLValidationReport rep)` Returns an iterator over the relationships in the base set.
    `java.util.Iterator<XBRLRelationship>` | XBRLRelationshipPoint.`getFromRelationships(XBRLArcroleType arcrole, DTSBase base)` Gets the from relationships.
    `java.util.Iterator<XBRLRelationship>` | XBRLRelationship.`getNext()` Access to the [Following] property of the chain of relationships.
    `java.util.Iterator<XBRLRelationship>` | XBRLRelationship.`getPrevious()` Access to the [Preceding] property of the chain of relationships.
    `java.util.Iterator<XBRLRelationship>` | XBRLExtendedLink.`getRelationships()` Access to the [Relationships] information item.
    `java.util.Iterator<XBRLRelationship>` | XBRLArc.`getRelationships()` Gets the relationships.
    `java.util.Iterator<XBRLRelationship>` | XBRLRelationshipPoint.`getToRelationships(XBRLArcroleType arcrole, DTSBase base)` Gets the to relationships.

    Methods in com.ihr.xbrl.om.exLinks with parameters of type XBRLRelationship
    Modifier and Type | Method and Description
    --- | ---
    `void` | XBRLRelationshipPoint.`addFromRelationship(XBRLRelationship rel)` Adds the from relationship.
    `void` | XBRLExtendedLink.`addRelationship(XBRLRelationship relationship)` Adds the relationship.
    `void` | DTSBase.`addRelationship(XBRLRelationship relationship)` Adds the relationship.
    `void` | XBRLRelationshipPoint.`addToRelationship(XBRLRelationship rel)` Adds the to relationship.
    `XBRLValidationReport` | XBRLlrrAndRelationshipConstraints.ExtraRelationshipValidationInterface.`extraValidateRelationship(XBRLRelationship rel)` Validates a relationship for additional constraints that cannot be included in the standard validation constraints.
    `static double` | CalculationLinkbase.`getWeight(XBRLRelationship rel)` Obtains the value of the weight attribute on a calculationArc (or derived) relationship.
    `void` | XBRLRelationshipPoint.`removeFromRelationship(XBRLRelationship rel)` Removes the from relationship.
    `boolean` | XBRLExtendedLink.`removeRelationship(XBRLRelationship relationship)` Removes the relationship.
    `boolean` | DTSBase.`removeRelationship(XBRLRelationship relationship)` Removes the relationship.
    `void` | XBRLRelationshipPoint.`removeToRelationship(XBRLRelationship rel)` Removes the to relationship.
    `void` | DTSBase.`serialize(XBRLRelationship rel, XBRLDocument document)` This function makes sure that: 1- the relationship exists in the appropriate ExtendedLink or creates the extended link 2- If the target is a resource, the resource is included in the ExtendedLink as well.
    `XBRLValidationReport` | XBRLlrrAndRelationshipConstraints.`validateRelationship(XBRLRelationship rel)` Validates the relationship received against the constraints stored in this class.
    `boolean` | XBRLExtendedLink.`wouldBeDuplicateArc(XBRLRelationship rel)` Checks wether or not the relationship in the parameter will be a duplicate relationship in this extended link.

    Constructors in com.ihr.xbrl.om.exLinks with parameters of type XBRLRelationship
    Constructor and Description
    `XBRLRelationship(XBRLRelationship other)` Instantiates a new XBRL relationship.

  - ### Uses of XBRLRelationship in com.ihr.xbrl.om.formula

    Methods in com.ihr.xbrl.om.formula with parameters of type XBRLRelationship
    Modifier and Type | Method and Description
    --- | ---
    `static XBRLFilterUse` | XBRLFilterUse.`createFilterUse(XBRLFormulaProcessor proc, XBRLRelationship rel, XBRLFormulaFilter filter)` Factory method.
    `XBRLVariableResourceUse` | XBRLVariableResource.`getUse(XBRLRelationship rel, XBRLVariablesHolder set)` Creates a new XBRLVariableResourceUse instance for this variable resource in the variable resource set.

  - ### Uses of XBRLRelationship in com.ihr.xbrl.om.formula.functions.reusable

    Method parameters in com.ihr.xbrl.om.formula.functions.reusable with type arguments of type XBRLRelationship
    Modifier and Type | Method and Description
    --- | ---
    `static void` | RC_XFI_concept_relationships_drs.`collectRelationships(java.util.ArrayList<XBRLRelationship> relationships, RC_XFI_concept_relationships_drs.Axis axis, XMLElementDefinition concept, java.util.Vector<XBRLRoleType> vRoles, int generations)` Collect relationships.
    `static void` | RC_XFI_concept_relationships.`collectRelationships(java.util.ArrayList<XBRLRelationship> relationships, RC_XFI_concept_relationships.Axis axis, XMLElementDefinition concept, java.util.Vector<XBRLRoleType> vRoles, java.util.Vector<XBRLArcroleType> vArcRoles, int generations, net.sf.saxon.value.QNameValue linkName, net.sf.saxon.value.QNameValue arcName)` Collect relationships.

  - ### Uses of XBRLRelationship in com.ihr.xbrl.om.table

    Methods in com.ihr.xbrl.om.table with parameters of type XBRLRelationship
    Modifier and Type | Method and Description
    --- | ---
    `static XBRLBreakdownUse` | XBRLBreakdownUse.`createBreakdownUse(XBRLRelationship rel, XBRLBreakdown breakdown)` Creates the breakdown use.
    `static XBRLDefinitionNodeUse` | XBRLDefinitionNodeUse.`createDefinitionNodeUse(XBRLRelationship rel, XBRLDefinitionNode definitionNodeSubTree, XBRLDefinitionNode parent)` Creates the definition node use.
    `static XBRLFilterUse` | XBRLFilterUse.`createFilterUse(XBRLTableProcessor proc, XBRLRelationship rel, XBRLFormulaFilter filter)` Factory method.

  - ### Uses of XBRLRelationship in com.ihr.xbrl.om.table.definition

    Constructor parameters in com.ihr.xbrl.om.table.definition with type arguments of type XBRLRelationship
    Constructor and Description
    `RelationshipGraphNode.GraphNodeBuildingParameters(XMLElementDefinition concept, java.util.ArrayList<XBRLRelationship> rels, boolean bIncludeSelf, boolean bIncludeFrom, RelationshipGraphNode.NodeFactory<Z> nf)` Information to build up the graph must be provided as an instance of this class.

  - ### Uses of XBRLRelationship in com.ihr.xbrl.om.taxonomy

    Methods in com.ihr.xbrl.om.taxonomy that return types with arguments of type XBRLRelationship
    Modifier and Type | Method and Description
    --- | ---
    `java.util.Iterator<XBRLRelationship>` | XBRLArcroleType.`getUses()` Access to the [arcrole uses] property The returned objects in the iterator are instances of XBRLRelationship elements.

    Methods in com.ihr.xbrl.om.taxonomy with parameters of type XBRLRelationship
    Modifier and Type | Method and Description
    --- | ---
    `void` | XBRLArcroleType.`addUse(XBRLRelationship here)` Adds the use.
    `void` | XBRLArcroleType.`delUse(XBRLRelationship rel)` Del use.

  - ### Uses of XBRLRelationship in com.ihr.xbrl.om.xdt

    Methods in com.ihr.xbrl.om.xdt with parameters of type XBRLRelationship
    Modifier and Type | Method and Description
    --- | ---
    `static XBRLRoleType` | XDTProcessor.`getTargetRole(XBRLRelationship rel)` Returns the XBRLRoleType pointed to by the xbrldt:targetRole attribute on the relationship rel.
    `static java.lang.Boolean` | XDTProcessor.`getUsable(XBRLRelationship rel)` Gets the usable.
    `static boolean` | XDTProcessor.`isClosed(XBRLRelationship rel)` Returns the value or default value of the xbrldt:closed attribute on the relationship indicated in the rel parameter.

    Constructors in com.ihr.xbrl.om.xdt with parameters of type XBRLRelationship
    Constructor and Description
    `XDTHypercubeUse(XDTProcessor processor, XDTHypercube hypercube, int arcRoleType, DTSBase useBase, DTSBase searchBase, DefinitionLinkbase tempDefLb, XBRLRelationship pri_hyp)` Instantiates a new XDT hypercube use.

  - ### Uses of XBRLRelationship in com.ihr.xbrl.pojo

    Methods in com.ihr.xbrl.pojo that return XBRLRelationship
    Modifier and Type | Method and Description
    --- | ---
    `XBRLRelationship` | XBRLRSGenerator.`generate(XBRLRelationship relIn)` Generate.

    Methods in com.ihr.xbrl.pojo with parameters of type XBRLRelationship
    Modifier and Type | Method and Description
    --- | ---
    `XBRLRelationship` | XBRLPojoGenerator.`generate(XBRLRelationship dtsRel)` Generate.