com.ihr.xbrl.om.formula.errors

Class XBRLResultMessage

java.lang.Object

net.sf.saxon.tree.linked.NodeImpl

net.sf.saxon.tree.linked.ElementImpl

com.ihr.xbrl.om.XMLFragment

com.ihr.xbrl.om.exLinks.XLinkElement

com.ihr.xbrl.om.exLinks.XBRLPointerOfARelationship

com.ihr.xbrl.om.exLinks.XBRLResource

com.ihr.xbrl.om.formula.XBRLFormulaResource

com.ihr.xbrl.om.formula.errors.XBRLResultMessage

All Implemented Interfaces:

HasDTSContainer, XBRLRelationshipPoint, HasFallbackValueResolver, HasFormulaProcessor, HasUncoveredAspectValueResolver, HasUncoveredDimensionalAspectsResolver, HasUncoveredNonDimensionalAspectsResolver, HasChangeHashSupport, XBRLValidation, XBRLValueKey, java.io.Serializable, java.lang.Cloneable, javax.xml.namespace.NamespaceContext, javax.xml.transform.Source, javax.xml.transform.SourceLocator, net.sf.saxon.evpull.PullEvent, net.sf.saxon.om.FingerprintedNode, net.sf.saxon.om.Item, net.sf.saxon.om.MutableNodeInfo, net.sf.saxon.om.NamespaceResolver, net.sf.saxon.om.NodeInfo, net.sf.saxon.om.Sequence, net.sf.saxon.tree.util.SteppingNode<net.sf.saxon.tree.linked.NodeImpl>, net.sf.saxon.tree.wrapper.SiblingCountingNode

public class XBRLResultMessage
extends XBRLFormulaResource
implements HasUncoveredAspectValueResolver, HasFallbackValueResolver, HasUncoveredDimensionalAspectsResolver, HasUncoveredNonDimensionalAspectsResolver

The Class XBRLResultMessage.

Author:

Ignacio

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.ihr.xbrl.om.XMLFragment

XMLFragment.NodeNameIterator<T extends XMLFragment>, XMLFragment.NodeTypeIterator<T extends XMLFragment>

Nested classes/interfaces inherited from interface com.ihr.xbrl.om.XBRLValidation

XBRLValidation.Direction

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	message_role_URI The Constant message_role_URI.
static javax.xml.namespace.QName	nodeName The Constant nodeName.
static javax.xml.namespace.QName	separator The Constant separator.
static java.lang.String	terse_message_role_URI The Constant terse_message_role_URI.
static java.lang.String	verbose_message_role_URI The Constant verbose_message_role_URI.

Fields inherited from class com.ihr.xbrl.om.formula.XBRLFormulaResource

log

Fields inherited from class com.ihr.xbrl.om.exLinks.XBRLResource

nullResource

Fields inherited from class com.ihr.xbrl.om.exLinks.XLinkElement

actuate, ARC, arcrole, ETITLE, EXTENDED, from, href, label, LOCATOR, RESOURCE, role, show, SIMPLE, title, to, X_ACTUATE, X_ARCROLE, X_FROM, X_HREF, X_LABEL, X_ROLE, X_SHOW, X_TITLE, X_TO, X_TYPE, XLINKPREFIX

Fields inherited from class com.ihr.xbrl.om.XMLFragment

ADD_NAMESPACE_INHERIT, baseQName, CONCEPT_LABEL, CONCEPT_QNAME, EASY_TO_READ, ELEMENT_LABEL, EMPTYRELATIONSHIPSITERATORINSTANCE, EMPTYXMLFRAGMENTITERATORINSTANCE, FACT_CONCEPT_DATATYPE, FACT_CONCEPT_LABEL, FACT_QNAME, FACT_VALUE, HIDE_COMMON_ACCURACY, idQName, langQName, nil, NO_POSITION, OrderComparator, OrderComparator2, OrderComparatorReverse, PERIOD_BOP, PERIOD_TYPE, PERIOD_VALUE, RELATIONSHIP_TYPE, RESOURCE_TYPE, SHORT_TEXT, SOURCE_DOCUMENT, XPATH, XPOINTER

Fields inherited from class net.sf.saxon.tree.linked.NodeImpl

NODE_LETTER

Fields inherited from interface net.sf.saxon.om.NodeInfo

ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES

Constructor Summary

Constructors

Constructor and Description
XBRLResultMessage(XBRLFormulaProcessor processor, XBRLResource fragment) Instantiates a new XBRL result message.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear.
java.lang.String	evaluateMessage(XBRLMessageContext assertion) Evaluate message.
net.sf.saxon.tree.linked.NodeImpl	getFirstChild()
net.sf.saxon.tree.linked.NodeImpl	getLastChild()
int	getNumberOfChildren()
java.lang.String	getSeparator() Gets the separator.
net.sf.saxon.s9api.XdmValue	getUncoveredAspectValue(Aspect aspect, Aspect dimName) Gets the uncovered aspect value.
java.util.Collection<net.sf.saxon.value.QNameValue>	getUncoveredDimensionalAspects() Gets the uncovered dimensional aspects.
java.util.Collection<net.sf.saxon.value.StringValue>	getUncoveredNonDimensionalAspects() Gets the uncovered non dimensional aspects.
XBRLVariableResourceUse	getVariableUse(javax.xml.namespace.QName variableName) Gets the variable use.
boolean	hasChildNodes()
boolean	isImplicitFilter() Checks if is implicit filter.

Methods inherited from class com.ihr.xbrl.om.formula.XBRLFormulaResource

addRequiredVariable, clearVariableSetDicoveredDuringExpressionCompilation, getProcessor, getRequiredVariableSetDiscoveredDuringExpressionCompilation, getResource

Methods inherited from class com.ihr.xbrl.om.exLinks.XBRLResource

addChild, clone, clone, equals, generateNode, getAttributes, getCode, getDTSBase, getFriendlyName, getFriendlyName, getFriendlyName, getParentXBRL, getResourceIdentifier, getRoleType, getType, getValidationReport, getValueKey, hashCode, invalidate, invalidate, isComplexType, isHashDependsOnAtribute, isOnValidation, isSimpleType, setCode, setComplexType, setDTSBase, setId, setRawParentXBRL, setRole, setRoleType, setSimpleType, setValue, validate

Methods inherited from class com.ihr.xbrl.om.exLinks.XLinkElement

getActuate, getArcrole, getFromTxt, getHRef, getHRefDocument, getHRefDocumentResolved, getHRefResolved, getLabel, getRawHRef, getReference, getRole, getShow, getStaticLabel, getSType, getTitle, getToTxt, isRequiredAttribute, isValidAttribute, setActuate, setArcrole, setFrom, setHRef, setLabel, setShow, setSType, setTitle, setTo, validateXPointer

Methods inherited from class com.ihr.xbrl.om.XMLFragment

addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addChildArray, addChildAt, addChildNode, addChildNodeArray, addChildNodeAt, addChildNodeInBatch, addComment, addFromRelationship, addNamespace, addNamespace, addPropertyChangeListener, addToRelationship, changeBase, checkBase, childExists, commitBatch, copy, createComment, delAttribute, delAttribute, delete, equalXdmValues, findFirstNodeOfClass, findPosition, firePropertyChangeEvent, generateId, generateLocatorToNode, generatePrefix, getAllAttributes, getAttribute, getAttributeAtomicValue, getAttributeBooleanValue, getAttributeGroundedValue, getAttributeQNameValue, getAttributeValue, getBase, getBase, getBooleanValue, getChildren, getChildStringValue, getConfiguration, getContainer, getContainerDocumentURI, getDocument, getElement, getElement, getElements, getFirstChildNoComment, getFragment, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getId, getInScopeNamespaces, getLang, getLastChildNoComment, getNamePool, getNamespaceBinding, getNamespaceURI, getNextSiblingNoComment, getNodeName, getNthElement, getNumberOfElements, getNumberOfFromRelationships, getNumberOfToRelationships, getOrGenerateId, getParentDocument, getPrefix, getPrefixes, getPropertyChangeListeners, getQNameValue, getRelationshipsBases, getRelationshipsChain, getRelationshipTypes, getStaticNamespace, getStringValue, getToolTipText, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getValue, getXPath, getXPathFromXPointer, getXPathNamespaceContext, getXPathToRoot, getXPointerElementScheme, getXPointerElementScheme, getXPointerShorthandScheme, getXPointerXPath2Scheme, initialise, internalToString, isAttribute, isChangeHashEnabled, isDead, isEmpty, isNamespaceDefined, isNil, moveNamespacesUp, objEquals, objHashCode, reindex, removeChild, removeChildNode, removeFromRelationship, removeNamespace, removePropertyChangeListener, removeToRelationship, replace, replaceChild, replaceStringValue, resetElements, resolveHRef, s_equal2_xp2, s_equal2_xp2, s_equal2, s_equal2, s_equal2, s_equal2, setAttributeList, setAttributes, setBase, setChildrenClone, setDirty, setElements, setLang, setModified, setNamespaceDeclarations, setNamespaces, setNil, setNodeName, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, valueEquals, xEqual

Methods inherited from class net.sf.saxon.tree.linked.ElementImpl

addAttribute, addNamespace, generateId, getAttributeList, getAttributeValue, getAttributeValue, getBaseURI, getColumnNumber, getDeclaredNamespaces, getDocumentRoot, getLineNumber, getNameCode, getNamespaceList, getNodeKind, getRoot, getSchemaType, getSystemId, getTypeAnnotation, getURIForPrefix, gsetAttributeCollection, isId, isInScopeNamespace, isNilled, iteratePrefixes, removeAttribute, removeTypeAnnotation, rename, setLocation, setNameCode, setNamespaceList, setSystemId, setTypeAnnotation

Methods inherited from class net.sf.saxon.tree.linked.NodeImpl

atomize, compareOrder, comparePosition, getDisplayName, getDocumentNumber, getFingerprint, getLocalPart, getNextInDocument, getNextSibling, getParent, getPhysicalRoot, getPrefix, getPreviousInDocument, getPreviousSibling, getPublicId, getSiblingPosition, getSuccessorElement, getURI, head, insertSiblings, isDeleted, isIdref, isSameNodeInfo, iterate, iterateAxis, iterateAxis, newBuilder, replace

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

nodeName

public static final javax.xml.namespace.QName nodeName

The Constant nodeName.

message_role_URI

public static final java.lang.String message_role_URI

The Constant message_role_URI.

See Also:

Constant Field Values

verbose_message_role_URI

public static final java.lang.String verbose_message_role_URI

The Constant verbose_message_role_URI.

See Also:

Constant Field Values

terse_message_role_URI

public static final java.lang.String terse_message_role_URI

The Constant terse_message_role_URI.

See Also:

Constant Field Values

separator

public static final javax.xml.namespace.QName separator

The Constant separator.

Constructor Detail

XBRLResultMessage

public XBRLResultMessage(XBRLFormulaProcessor processor,
                         XBRLResource fragment)
                  throws XFValidationException

Instantiates a new XBRL result message.

Parameters:

processor - the processor

fragment - the fragment

Throws:

XFValidationException - the XF validation exception

Method Detail

getSeparator

public java.lang.String getSeparator()

Gets the separator.

Returns:

the separator

evaluateMessage

public java.lang.String evaluateMessage(XBRLMessageContext assertion)
                                 throws XFValidationException

Evaluate message.

Parameters:

assertion - the assertion MUST be either an instance of the XBRLAssertion class or derived object or an XBRLConsistencyAssertion object

Returns:

String message evaluated

Throws:

XFValidationException - the XF validation exception

getVariableUse

public XBRLVariableResourceUse getVariableUse(javax.xml.namespace.QName variableName)

Gets the variable use.

Specified by:

getVariableUse in interface HasFallbackValueResolver

Parameters:

variableName - the variable name

Returns:

the variable use

getUncoveredAspectValue

public net.sf.saxon.s9api.XdmValue getUncoveredAspectValue(Aspect aspect,
                                                           Aspect dimName)
                                                    throws XFValidationException

Gets the uncovered aspect value.

Specified by:

getUncoveredAspectValue in interface HasUncoveredAspectValueResolver

Parameters:

aspect - the aspect

dimName - the dim name

Returns:

the uncovered aspect value

Throws:

XFValidationException - the XF validation exception

isImplicitFilter

public boolean isImplicitFilter()

Checks if is implicit filter.

Specified by:

isImplicitFilter in interface HasUncoveredAspectValueResolver

Returns:

true, if is implicit filter

getUncoveredDimensionalAspects

public java.util.Collection<net.sf.saxon.value.QNameValue> getUncoveredDimensionalAspects()

Gets the uncovered dimensional aspects.

Specified by:

getUncoveredDimensionalAspects in interface HasUncoveredDimensionalAspectsResolver

Returns:

the uncovered dimensional aspects

getUncoveredNonDimensionalAspects

public java.util.Collection<net.sf.saxon.value.StringValue> getUncoveredNonDimensionalAspects()

Gets the uncovered non dimensional aspects.

Specified by:

getUncoveredNonDimensionalAspects in interface HasUncoveredNonDimensionalAspectsResolver

Returns:

the uncovered non dimensional aspects

clear

public void clear()
           throws java.lang.Throwable

Clear.

Overrides:

clear in class XBRLFormulaResource

Throws:

java.lang.Throwable - the throwable

hasChildNodes

public final boolean hasChildNodes()

Specified by:

hasChildNodes in interface net.sf.saxon.om.NodeInfo

Overrides:

hasChildNodes in class net.sf.saxon.tree.linked.NodeImpl

getNumberOfChildren

public final int getNumberOfChildren()

getFirstChild

public final net.sf.saxon.tree.linked.NodeImpl getFirstChild()

Specified by:

getFirstChild in interface net.sf.saxon.tree.util.SteppingNode<net.sf.saxon.tree.linked.NodeImpl>

Overrides:

getFirstChild in class net.sf.saxon.tree.linked.NodeImpl

getLastChild

public final net.sf.saxon.tree.linked.NodeImpl getLastChild()

Overrides:

getLastChild in class net.sf.saxon.tree.linked.NodeImpl