public abstract class MapperPeriodBase extends XMLFragment implements MapperPeriod
| Modifier and Type | Field and Description |
|---|---|
static int |
DATE_END
Constant to refer to the END date or datetime of this period.
|
static int |
DATE_INSTANT
Constant to refer to the INSTANT date or datetime of this period.
|
static int |
DATE_START
Constant to refer to the START date or datetime of this period.
|
static javax.xml.namespace.QName |
periodNode
Constant xbrli:period used during serialization of periods.
|
CONCEPT_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 |
|---|
MapperPeriodBase(DTSContainer dts)
Instantiates a new mapper period base.
|
MapperPeriodBase(DTSContainer dts,
net.sf.saxon.s9api.XdmNode node)
Instantiates a new mapper period base.
|
MapperPeriodBase(MapperPeriodBase other)
Creates an new period as a copy of the current period.
|
MapperPeriodBase(XBRLPeriod period)
Instantiates a new mapper period base.
|
| Modifier and Type | Method and Description |
|---|---|
abstract MapperPeriodBase |
clone()
Clone.
|
boolean |
equals(java.lang.Object other)
Sets a new XPathFunctionResolver for this object.
|
org.jdom.Element |
generateNode(boolean relativize,
java.net.URI base)
Serializes to a jdom Element the representation of the properties of this Information Item
This method should be called from classes derived from this class
|
java.lang.String |
getDate(int type,
boolean operate)
String representation of the date in the period. adjusted according to XBRL specification rules.
|
java.util.Iterator<XMLFragment> |
getElements()
For complex type resources this returns an iterator with all children XML fragments
This method may be overwriten by other classes in the hierarchy.
|
java.util.GregorianCalendar |
getGregorianCalendarDate(int type)
Returns the value of the date for the type requested.
|
XBRLItem.PeriodType |
getPeriodType()
Returns XBRLItem.DURATION or XBRLItem.INSTANT depending on the context period information.
|
java.lang.String |
getRawDate(int type,
boolean operate)
String representation of the date in the period.
|
java.util.Date |
getRawDateUtil(int code)
Returns the raw date (the one specified by syntax) in the context.
|
java.util.GregorianCalendar |
getRawGregorianCalendarDate(int type)
Returns the value of the date for the type requested.
|
XBRLPeriod |
getXBRLPeriod()
Gets the XBRL period.
|
int |
hashCode()
Hash code.
|
boolean |
isDuration()
Checks if is duration.
|
boolean |
isForever()
Checks if is forever.
|
boolean |
isInstant()
Checks if is instant.
|
boolean |
isMacroPeriod()
Returns true only if the period content is a string of text that can be evaluated as a macro.
|
void |
setDate(int type,
java.lang.String strDate)
Sets the value of the specified field.
|
java.lang.String |
toString()
Returns the XML representation of this object as an String.
|
addAttribute, addChild, addFromRelationship, addNamespace, addNamespace, addToRelationship, addXMLChild, changeBase, checkBase, clear, clone, delAttribute, delAttribute, equalXdmValues, evaluateBoolean, evaluateList, evaluateNode, evaluateNumber, evaluateString, generateId, generateNodeNamespacesAndAttributes, generateNodeValue, generatePrefix, getAllAttributes, getAttribute, getAttributeBooleanValue, getAttributeQNameValue, getAttributes, getAttributes, getAttributeStringValue, getAttributeValue, getBase, getBase, getBaseURI, getBooleanValue, getChild, getContainer, getContainerDocumentURI, getDeclaredNamespaces, getDocument, getElementsHashCode, getFragment, getFriendlyName, getFriendlyName, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getFromRelationships, getGenericLabelText, getId, getLang, getNamespaceURI, getNodeName, getNumberOfAttributes, getNumberOfElements, getNumberOfFromRelationships, getNumberOfToRelationships, getOrGenerateId, getParent, 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, setId, setLang, setNamespaceContext, setNamespaces, setNode, setNodeName, setParent, setRegenerateNodeIfnotFound, setValue, setValue, setVariablesDefined, size, thin, valueEquals, xEqualpublic static final javax.xml.namespace.QName periodNode
public static final int DATE_INSTANT
public static final int DATE_START
public static final int DATE_END
public MapperPeriodBase(DTSContainer dts)
dts - the dtspublic MapperPeriodBase(DTSContainer dts, net.sf.saxon.s9api.XdmNode node)
dts - the dtsnode - the nodepublic MapperPeriodBase(MapperPeriodBase other)
other - XBRLPeriodpublic MapperPeriodBase(XBRLPeriod period)
period - the periodpublic abstract MapperPeriodBase clone()
MapperPeriodclone in interface MapperPeriodclone in class XMLFragmentpublic org.jdom.Element generateNode(boolean relativize,
java.net.URI base)
throws XBRLSerializationException
XMLFragmentgenerateNode in interface MapperPeriodgenerateNode in class XMLFragmentrelativize - boolean indicating if URIs should be relativized to the base URI (see next argument)base - the URI to which some attributes of this object should be relatividedXBRLSerializationException - the XBRL serialization exceptionpublic XBRLItem.PeriodType getPeriodType()
getPeriodType in interface MapperPeriodpublic boolean isInstant()
isInstant in interface MapperPeriodpublic boolean isDuration()
isDuration in interface MapperPeriodpublic boolean isMacroPeriod()
isMacroPeriod in interface MapperPeriodpublic boolean isForever()
isForever in interface MapperPeriodpublic java.lang.String getDate(int type,
boolean operate)
getDate in interface MapperPeriodtype - code indicating what to obtain. DATE_INSTANT, DATE_START or DATE_ENDoperate - the operatepublic java.lang.String getRawDate(int type,
boolean operate)
getRawDate in interface MapperPeriodtype - code indicating what to obtain. DATE_INSTANT, DATE_START or DATE_ENDoperate - the operatepublic java.util.GregorianCalendar getGregorianCalendarDate(int type)
getGregorianCalendarDate in interface MapperPeriodtype - one of the constants belowpublic java.util.GregorianCalendar getRawGregorianCalendarDate(int type)
getRawGregorianCalendarDate in interface MapperPeriodtype - one of the constants belowpublic void setDate(int type,
java.lang.String strDate)
throws XBRLValidationException
setDate in interface MapperPeriodtype - this is the field, DATE_END, DATE_INSTANT, DATE_STARTstrDate - iso8601 date stringXBRLValidationException - the XBRL validation exceptionpublic java.util.Date getRawDateUtil(int code)
getRawDateUtil in interface MapperPeriodcode - this is the field, DATE_END, DATE_INSTANT, DATE_STARTpublic java.lang.String toString()
XMLFragmenttoString in interface MapperPeriodtoString in class XMLFragmentpublic java.util.Iterator<XMLFragment> getElements()
XMLFragmentgetElements in interface MapperPeriodgetElements in class XMLFragmentpublic XBRLPeriod getXBRLPeriod()
getXBRLPeriod in interface MapperPeriodpublic boolean equals(java.lang.Object other)
XMLFragmentequals in interface MapperPeriodequals in class XMLFragmentother - the otherpublic int hashCode()
MapperPeriodhashCode in interface MapperPeriodhashCode in class XMLFragment