public class XBRLVariableGeneral extends XBRLVariableResource
XBRLValidation.Direction| Modifier and Type | Field and Description |
|---|---|
static javax.xml.namespace.QName |
resourceName
The Constant resourceName.
|
static javax.xml.namespace.QName |
select
The Constant select.
|
as, bindAsSequence, name, ordernullResourceactuate, ACTUATE, ARC, arcrole, ARCROLE, ETITLE, EXTENDED, from, FROM, href, HREF, label, LABEL, LOCATOR, RESOURCE, role, ROLE, show, SHOW, SIMPLE, title, TITLE, to, TO, TYPECONCEPT_LABEL, CONCEPT_QNAME, EASY_TO_READ, ELEMENT_LABEL, EMPTYRELATIONSHIPSITERATORINSTANCE, EMPTYXMLFRAGMENTITERATORINSTANCE, FACT_CONCEPT_DATATYPE, FACT_CONCEPT_LABEL, FACT_QNAME, HIDE_COMMON_ACCURACY, idQName, NO_POSITION, OrderComparator, OrderComparator2, PERIOD_TYPE, PERIOD_VALUE, SHORT_TEXT, SOURCE_DOCUMENT, XPATH, XPOINTER| Constructor and Description |
|---|
XBRLVariableGeneral(XBRLFormulaProcessor formulaProcessor,
XBRLResource res)
Instantiates a new XBRL variable general.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
checkVariable(XBRLVariablesHolder set,
javax.xml.namespace.QName name,
java.util.Collection<net.sf.saxon.s9api.QName> resolved)
Called for variables that are also resources during the static compilation phase of the formula preparation.
|
void |
clear()
Removes all referneces to this resource in the DTS.
|
Evaluation |
evaluateValue(XMLFragment evaluationContext,
java.util.Collection<XBRLVariableResourceUse> availableVars,
XBRLVariableSetResource set)
Evaluates the resource internal XPath expression and returns either the returned value from the XPath expression
or the fall back value in the case of variables that may have a fall back value and the rawEvaluation of the
XPath expression results in the empty sequence.
|
java.lang.String |
getExpression()
Used only for debug purposes.
|
java.util.Collection<javax.xml.namespace.QName> |
getVariablesRequired(XBRLVariablesHolder set)
Returns a collection of variables required for the evaluation of this variable.
|
XMLFragment |
getXMLFragment()
Returns the surrounding XML Fragment this resource comes from.
|
Evaluation |
rawEvaluateValue(XMLFragment evaluationContext,
java.util.Collection<XBRLVariableResourceUse> availableVars)
Evaluates the resource internal XPath expression and returns the sequence.
|
adjustValueAccordingToType, bindAsSequence, getAllAspectsFiltered, getFilters, getKeysAspectsFiltered, getUse, getVariableType, hasFilterAspectgetProcessoraddChild, equals, generateLocatorToNode, generateNode, getAttributes, getDTSBase, getFriendlyName, getFriendlyName, getParent, getResourceIdentifier, getRoleType, getType, getValidationReport, getValueKey, hashCode, invalidate, invalidate, isComplexType, isOnValidation, isSimpleType, setComplexType, setDTSBase, setId, setParent, setRole, setRoleType, setSimpleType, setValue, validategetActuate, getArcrole, getFromTxt, getHRef, getLabel, getRole, getShow, getStaticLabel, getSType, getTitle, getToTxt, isRequiredAttribute, isValidAttribute, setActuate, setArcrole, setFrom, setHRef, setLabel, setShow, setSType, setTitle, setToaddAttribute, addFromRelationship, addNamespace, addNamespace, addToRelationship, addXMLChild, changeBase, checkBase, clone, clone, delAttribute, delAttribute, equalXdmValues, evaluateBoolean, evaluateList, evaluateNode, evaluateNumber, evaluateString, generateId, generateNodeNamespacesAndAttributes, generateNodeValue, generatePrefix, getAllAttributes, getAttribute, getAttributeBooleanValue, getAttributeQNameValue, getAttributes, getAttributeStringValue, getAttributeValue, getBase, getBase, getBaseURI, getBooleanValue, getChild, getContainer, getContainerDocumentURI, getDeclaredNamespaces, getDocument, getElements, getElementsHashCode, getFragment, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getGenericLabelText, getId, getLang, getNamespaceURI, getNodeName, getNumberOfAttributes, getNumberOfElements, getNumberOfFromRelationships, getNumberOfToRelationships, getOrGenerateId, getPrefix, getPrefixes, getQNameValue, getRelationshipsBases, getRelationshipsChain, getRelationshipTypes, getStaticContext, getStaticNamespace, getStringValue, getToolTipText, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getToRelationships, getValue, getXPathExecutable, getXPathNamespaceContext, getXPathToNode, getXPathToRoot, getXPointerElementScheme, getXPointerElementScheme, getXPointerShorthandScheme, getXPointerToNode, isDead, isNamespaceDefined, isXdmDocumentAttached, objEquals, objHashCode, qNameToString, removeAttribute, removeChild, removeChild, removeFromRelationship, removeToRelationship, removeXMLChild, resetElements, resetHash, resolve_equal2, resolveHRef, resolveHRef, s_equal2, s_equal2, s_equal2, setAttributes, setBase, setDocument, setDocumentAndReload, setElements, setLang, setNamespaceContext, setNamespaces, setNode, setNodeName, setParent, setRegenerateNodeIfnotFound, setValue, setVariablesDefined, size, thin, toString, valueEquals, xEqualgetProcessoraddFromRelationship, addToRelationship, getFromRelationships, getToRelationships, removeFromRelationship, removeToRelationshippublic static final javax.xml.namespace.QName resourceName
public static final javax.xml.namespace.QName select
public XBRLVariableGeneral(XBRLFormulaProcessor formulaProcessor, XBRLResource res) throws XFValidationException
formulaProcessor - the formula processorres - the resXFValidationException - the XF validation exceptionpublic Evaluation evaluateValue(XMLFragment evaluationContext, java.util.Collection<XBRLVariableResourceUse> availableVars, XBRLVariableSetResource set) throws XFValidationException
XBRLVariableFormulaEvaluableevaluationContext - the evaluation contextavailableVars - the available varsset - the setXFValidationException - the XF validation exceptionXBRLVariableFormulaEvaluable.rawEvaluateValue(XMLFragment, Collection)public Evaluation rawEvaluateValue(XMLFragment evaluationContext, java.util.Collection<XBRLVariableResourceUse> availableVars) throws XFValidationException
XBRLVariableFormulaEvaluableXBRLVariableFormulaEvaluable.evaluateValue(XMLFragment, Collection, XBRLVariableSetResource) method.evaluationContext - the evaluation contextavailableVars - the available varsXFValidationException - the XF validation exceptionpublic void clear()
XBRLResourceclear in interface XBRLVariableFormulaEvaluableclear in class XBRLVariableResourcepublic boolean checkVariable(XBRLVariablesHolder set, javax.xml.namespace.QName name, java.util.Collection<net.sf.saxon.s9api.QName> resolved) throws XFValidationException
XBRLVariableFormulaEvaluablethrows exceptions according to the validation rules.
shall return true on success
set - the setname - the nameresolved - the resolvedXFValidationException - the XF validation exceptionpublic java.util.Collection<javax.xml.namespace.QName> getVariablesRequired(XBRLVariablesHolder set)
XBRLVariableFormulaEvaluableset - the setpublic java.lang.String getExpression()
XBRLVariableResourceReturns the XPath expression used to evaluate this variable
getExpression in class XBRLVariableResourcepublic XMLFragment getXMLFragment()
XBRLVariableFormulaEvaluable