com.ihr.xbrl.om.exLinks

Class XBRLlrrAndRelationshipConstraints

java.lang.Object

com.ihr.xbrl.om.exLinks.XBRLlrrAndRelationshipConstraints

public class XBRLlrrAndRelationshipConstraints
extends java.lang.Object

The purpose of this class is to centralize here all information related to validation of relationships. This class will be a an instance per DTSContainer and all methods will be thread safe. During class initialization the latest version of the lrr will be used as input to populate the internal structures. Then the internal structures will be populated with the information from other sources such as processors. Other processors may add constraints to the singleton as they are created. if the processors's surrounding specification is defining constraints to the relationships they define in link:arcroleType elements

Since:

2.7.7

Author:

Ignacio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XBRLlrrAndRelationshipConstraints.ConstraintsBase The Class ConstraintsBase.
static class	XBRLlrrAndRelationshipConstraints.ExtendedLinkConstraints The Class ExtendedLinkConstraints.
static interface	XBRLlrrAndRelationshipConstraints.ExtraRelationshipValidationInterface This interface defines a method for classes implementing additional validation constraints for a relationship that cannot be implemented in a generic way.
static class	XBRLlrrAndRelationshipConstraints.RelationshipConstraints The Class RelationshipConstraintsBase.
static interface	XBRLlrrAndRelationshipConstraints.ValidateRelationshipAnchor Used to validate from and to parts of a relationship.

Constructor Summary

Constructors

Constructor and Description
XBRLlrrAndRelationshipConstraints(DTSContainer dts) Disallow creating new instances of this processor.

Method Summary

Modifier and Type	Method and Description
void	addArcroleConstraints(java.lang.String arcRole, XBRLlrrAndRelationshipConstraints.RelationshipConstraints newConstraints) Adds new constraints to this processor.
void	addExtendedLinkConstraints(javax.xml.namespace.QName linkType, XBRLlrrAndRelationshipConstraints.ExtendedLinkConstraints newConstraints) Adds new constraints to this processor.
void	clear() Releases all constraints read and memory used on this class.
DTSContainer	getContainer() Access to the DTSContainer .
XBRLlrrAndRelationshipConstraints.ExtendedLinkConstraints	getExtendedLinkConstraints(javax.xml.namespace.QName lbType) Gets the extended link constraints.
XBRLlrrAndRelationshipConstraints.RelationshipConstraints	getRelationshipConstraints(java.lang.String arcrole) Gets the relationship constraints.
XBRLValidationReport	validateRelationship(XBRLExtendedLink parent, XBRLRelationship rel) Validates the relationship received against the constraints stored in this class.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XBRLlrrAndRelationshipConstraints

public XBRLlrrAndRelationshipConstraints(DTSContainer dts)

Disallow creating new instances of this processor.

Parameters:

dts - the dts

Method Detail

clear

public void clear()

Releases all constraints read and memory used on this class.

After calling this method it will not be possible to validate new relationships.

getContainer

public DTSContainer getContainer()

Access to the DTSContainer .

Returns:

the container

addArcroleConstraints

public void addArcroleConstraints(java.lang.String arcRole,
                                  XBRLlrrAndRelationshipConstraints.RelationshipConstraints newConstraints)

Adds new constraints to this processor. This method is used by processors during the processor initialization phase.

Parameters:

arcRole - the arc role

newConstraints - the new constraints

addExtendedLinkConstraints

public void addExtendedLinkConstraints(javax.xml.namespace.QName linkType,
                                       XBRLlrrAndRelationshipConstraints.ExtendedLinkConstraints newConstraints)

Adds new constraints to this processor. This method is used by processors during the processor initialization phase.

Parameters:

linkType - the linkbase type the constraints will be added to

newConstraints - the new constraints

validateRelationship

public XBRLValidationReport validateRelationship(XBRLExtendedLink parent,
                                                 XBRLRelationship rel)

Validates the relationship received against the constraints stored in this class.

Parameters:

parent - the extended link that will be the repationship parent

rel - the relationship to validate

Returns:

the XBRL validation report

getRelationshipConstraints

public XBRLlrrAndRelationshipConstraints.RelationshipConstraints getRelationshipConstraints(java.lang.String arcrole)

Gets the relationship constraints.

Parameters:

arcrole - the arcrole

Returns:

the relationship constraints

getExtendedLinkConstraints

public XBRLlrrAndRelationshipConstraints.ExtendedLinkConstraints getExtendedLinkConstraints(javax.xml.namespace.QName lbType)

Gets the extended link constraints.

Parameters:

lbType - the lb type

Returns:

the extended link constraints