com.ihr.xbrl.om.formula.filters
Class XBRLPeriodFilter

java.lang.Object
  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.filters.XBRLPeriodFilterAbstract
                          com.ihr.xbrl.om.formula.filters.XBRLPeriodFilter

All Implemented Interfaces:

XBRLRelationshipPoint, XBRLFormulaFilter, HasFormulaProcessor, XBRLValueKey, XMLHasParent, java.lang.Cloneable, javax.xml.namespace.NamespaceContext

public class XBRLPeriodFilter
extends XBRLPeriodFilterAbstract

Author:

Ignacio

Field Summary

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

nullResource

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

actuate, ACTUATE, ARC, arcrole, ARCROLE, ETITLE, EXTENDED, from, FROM, href, HREF, label, LABEL, LOCATOR, RESOURCE, role, ROLE, show, SHOW, SIMPLE, title, TITLE, to, TO, TYPE

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

CONCEPT_LABEL, CONCEPT_QNAME, EMPTYRELATIONSHIPSITERATORINSTANCE, EMPTYXMLFRAGMENTITERATORINSTANCE, FACT_CONCEPT_DATATYPE, FACT_CONCEPT_LABEL, FACT_QNAME, idQName, NO_POSITION, OrderComparator, PERIOD_TYPE, PERIOD_VALUE, SHORT_TEXT, SOURCE_DOCUMENT, XPATH, XPOINTER

Constructor Summary

XBRLPeriodFilter(XBRLFormulaProcessor proc, XBRLResource other)

Method Summary

void	collectVariables(java.util.Collection<javax.xml.namespace.QName> col, java.util.Collection<net.sf.saxon.s9api.QName> resolved) This method is called after the filter has been compiled.
int	getFilterWeight() Returns a number assigned statically to every filter type in order to facilitate evaluate the right order in which filters should be concatenated in an XPath expression or Boolean Filter.

Methods inherited from class com.ihr.xbrl.om.formula.filters.XBRLPeriodFilterAbstract

getCorevedAspect, getXPathTerm

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

getProcessor

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

addChild, clear, equals, generateLocatorToNode, generateNode, getAttributes, getDTSBase, getFriendlyName, getFriendlyName, getParent, getRoleType, getType, getValueKey, hashCode, isComplexType, isSimpleType, setComplexType, setDTSBase, setId, setParent, setRole, setRoleType, setSimpleType, setValue

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

getActuate, getArcrole, getFromTxt, getHRef, getLabel, getRole, getShow, getStaticLabel, getSType, getTitle, getToTxt, isRequiredAttribute, isValidAttribute, setActuate, setArcrole, setFrom, setHRef, setLabel, setShow, setSType, setTitle, setTo

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

addAttribute, addFromRelationship, addNamespace, addNamespace, addToRelationship, addXMLChild, changeBase, checkBase, clone, clone, delAttribute, delAttribute, equalXdmValues, evaluateBoolean, evaluateList, evaluateNode, evaluateNumber, evaluateString, generateId, generateNodeNamespacesAndAttributes, generateNodeValue, generatePrefix, getAttribute, getAttributeQNameValue, getAttributes, getAttributeValue, getBase, getBase, getBaseURI, getBooleanValue, getChild, getContainer, getDeclaredNamespaces, getDocument, getElements, getFragment, getFromRelationships, getFromRelationships, getFromRelationships, getId, getLang, getNamespaceURI, getNodeName, getNumberOfElements, getNumberOfFromRelationships, getNumberOfToRelationships, getOrGenerateId, getPrefix, getPrefixes, getQNameValue, getRelationshipsBases, getRelationshipsChain, getRelationshipTypes, getStaticNamespace, getStringValue, getToRelationships, getToRelationships, getToRelationships, getValue, getXPathNamespaceContext, getXPathToNode, getXPathToRoot, getXPointerElementScheme, getXPointerElementScheme, getXPointerShorthandScheme, getXPointerToNode, isNamespaceDefined, objEquals, objHashCode, qNameToString, removeAttribute, removeChild, removeChild, removeFromRelationship, removeToRelationship, removeXMLChild, resetElements, resetHash, resolveHRef, resolveHRef, s_equal2, s_equal2, setAttributes, setBase, setDocument, setDocumentAndReload, setElements, setLang, setNamespaceContext, setNamespaces, setNode, setNodeName, setParent, setValue, setVariablesDefined, toString, valueEquals, xEqual

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ihr.xbrl.om.formula.filters.XBRLFormulaFilter

getLabel

Methods inherited from interface com.ihr.xbrl.om.exLinks.XBRLRelationshipPoint

addFromRelationship, addToRelationship, getFromRelationships, getToRelationships, removeFromRelationship, removeToRelationship

Constructor Detail

XBRLPeriodFilter

public XBRLPeriodFilter(XBRLFormulaProcessor proc,
                        XBRLResource other)

Parameters:

proc -

other -

Method Detail

collectVariables

public void collectVariables(java.util.Collection<javax.xml.namespace.QName> col,
                             java.util.Collection<net.sf.saxon.s9api.QName> resolved)

Description copied from interface: XBRLFormulaFilter

This method is called after the filter has been compiled. The method must add to the parameter all variables required for the evaluation of the XPath sentence that will be returned by the getXPathTerm() method

Parameters:

col - the collection where variables will be appended

getFilterWeight

public int getFilterWeight()

Description copied from interface: XBRLFormulaFilter

Returns a number assigned statically to every filter type in order to facilitate evaluate the right order in which filters should be concatenated in an XPath expression or Boolean Filter. The number is assigned in a table inside the XBRLFilterOrderTool class

Returns:

integer for comparison of filter order