com.ihr.xbrl.om.instance

Class XBRLPeriod

java.lang.Object

net.sf.saxon.tree.linked.NodeImpl

net.sf.saxon.tree.linked.ElementImpl

com.ihr.xbrl.om.XMLFragment

com.ihr.xbrl.om.instance.XBRLPeriod

All Implemented Interfaces:

HasDTSContainer, XBRLRelationshipPoint, HasChangeHashSupport, 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 XBRLPeriod
extends XMLFragment
implements java.lang.Cloneable

A period information according to the content of the context container in the XBRL 2.1 specification.

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>

Field Summary

Fields

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.
static net.sf.saxon.om.StructuredQName	sqnPeriodNode The Constant sqnPeriodNode.
static java.util.Comparator<XBRLPeriod>	TimeSorterInstance Sorts Periods so they are ordered according to the following criteria: (a) duration periods are ordered according to the date in the middle of the period.
static java.util.Comparator<XBRLPeriod>	TimeSorterReverseInstance Sorts Periods as reverse TimeSorter order.

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
XBRLPeriod(DTSContainer dts, boolean forever) Creates a FOREVER period.
XBRLPeriod(DTSContainer dts, java.util.GregorianCalendar instant, boolean bHasTimeZone, boolean bHasTime) Creates a INSTANT period with the instant date The date value will be set to the Gregorian Calendar used in the parameter.
XBRLPeriod(DTSContainer dts, java.util.GregorianCalendar start, java.util.GregorianCalendar end, boolean bHasTimeZone, boolean bHasTime) Instantiates a new XBRL period.
XBRLPeriod(DTSContainer dts, java.lang.String instantDate) Creates a INSTANT period with the instantDate Note: As dates are in ISO 8601 format, the date representation "2007-08-31" is assumed to be in the NO_TIMEZONE time zone.
XBRLPeriod(DTSContainer dts, java.lang.String startDate, java.lang.String endDate) Creates a DURATION period with the startDate and endDate Note: As dates are in ISO 8601 format, the date representation "2007-08-31" is assumed to be in the NO_TIMEZONE time zone.
XBRLPeriod(XMLFragment node) Creates a XBRLPeriod reading the content of the XMLFragment node supplied as a parameter.

Method Summary

Modifier and Type	Method and Description
static java.util.GregorianCalendar	adjust24h(java.util.GregorianCalendar calendar, boolean sign) Adjust24h.
void	clear() Clear.
XBRLPeriod	clone() Clone.
XBRLPeriod	clone(DTSContainer newDTS) Clone.
boolean	equals(java.lang.Object other) Equals.
XMLFragment	generateNode() Generate node.
static net.sf.saxon.value.CalendarValue	getCalendarValue(java.lang.CharSequence cs) Gets the calendar value.
java.util.GregorianCalendar	getComparableDate() Gets the comparable date.
java.lang.String	getDate(int type) String representation of the date in the period. adjusted according to XBRL specification rules.
XMLFragment	getElementEndDate() Gets the element end date.
XMLFragment	getElementForever() Gets the element forever.
XMLFragment	getElementInstant() Gets the element instant.
XMLFragment	getElementStartDate() Gets the element start date.
net.sf.saxon.tree.linked.NodeImpl	getFirstChild()
java.lang.String	getFriendlyName() Gets the friendly name.
java.lang.String	getFriendlyName(int use) Gets the friendly name.
java.lang.String	getFriendlyName(int modifiers, LabelsProvider lp) Gets the friendly name.
java.util.GregorianCalendar	getGregorianCalendarDate(int type) Returns the value of the date for the type requested.
net.sf.saxon.tree.linked.NodeImpl	getLastChild()
java.lang.String	getLocalizedPeriodType() Returns a localized string representing the period type. this is, in English "instant" or "duration".
static java.lang.String	getLocalizedPeriodType(XBRLItem.PeriodType periodType) Returns a localized string representing the period type. this is, in English "instant" or "duration".
int	getNumberOfChildren()
XBRLItem.PeriodType	getPeriodType() Returns XBRLItem.DURATION or XBRLItem.INSTANT depending on the context period information.
java.lang.String	getRawDate(int type) 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.
boolean	hasChildNodes()
int	hashCode() Hash code.
boolean	isDuration() Checks if is duration.
boolean	isForever() Checks if is forever.
boolean	isHasDateAndTime() Returns true if the date contains date and time.
boolean	isHasTimeZone() Returns true if the date contains time zone.
boolean	isInstant() Checks if is instant.
static java.lang.String	iso8601(java.util.GregorianCalendar c, boolean hasTimezone, boolean hasTime) Returns a string representation in iso8601 standard with the value of variable c yyyy-MM-dd'T'HH:mm:ss.SSSZ is the complete patters that can be used some parts of this pattern can be omited according to the values of hasTimezone and hasTime below.
static java.util.GregorianCalendar	iso8601(java.lang.String value, boolean bAdd24h) Converts a string of the format yyyy-MM-dd to the apropriate GregorianCalendar object.
static XBRLPeriod	make(DTSContainer dts) Make.
boolean	s_equal2(java.lang.Object other) S equal 2.
void	setDate(int type, java.lang.String strDate) Sets the value of the specified field.
void	setForever() Change this period to a <forever/> period.
XBRLValidationReport	validate() Produces a XBRLValidationReport object for this period object.

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, addChild, 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, getAttributes, 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, getParentXBRL, 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, isHashDependsOnAtribute, 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, setAttributeList, setAttributes, setBase, setChildrenClone, setDirty, setElements, setId, setLang, setModified, setNamespaceDeclarations, setNamespaces, setNil, setNodeName, setRawParentXBRL, setValue, 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

TimeSorterInstance

public static final java.util.Comparator<XBRLPeriod> TimeSorterInstance

Sorts Periods so they are ordered according to the following criteria:

(a) duration periods are ordered according to the date in the middle of the period.

(b) instant periods are ordered according to the date represented.

(c) Forever periods are duration periods. they are equal to forever periods or always start earlier that any other duration period. Forever period and instant period comparison result in -1.

(d) Instant and Duration periods are ordered according to a date that is in the middle of the period

TimeSorterReverseInstance

public static final java.util.Comparator<XBRLPeriod> TimeSorterReverseInstance

Sorts Periods as reverse TimeSorter order.

periodNode

public static final javax.xml.namespace.QName periodNode

Constant xbrli:period used during serialization of periods.

sqnPeriodNode

public static final net.sf.saxon.om.StructuredQName sqnPeriodNode

The Constant sqnPeriodNode.

DATE_INSTANT

public static final int DATE_INSTANT

Constant to refer to the INSTANT date or datetime of this period.

See Also:

Constant Field Values

DATE_START

public static final int DATE_START

Constant to refer to the START date or datetime of this period.

See Also:

Constant Field Values

DATE_END

public static final int DATE_END

Constant to refer to the END date or datetime of this period.

See Also:

Constant Field Values

Constructor Detail

XBRLPeriod

public XBRLPeriod(XMLFragment node)

Creates a XBRLPeriod reading the content of the XMLFragment node supplied as a parameter.

Parameters:

node - XMLFragment XML node s9api where data will be read from

XBRLPeriod

public XBRLPeriod(DTSContainer dts,
                  boolean forever)

Creates a FOREVER period. the value of the forever argument is not used.

Parameters:

dts - DTSContainer

forever - true if is forever

XBRLPeriod

public XBRLPeriod(DTSContainer dts,
                  java.lang.String startDate,
                  java.lang.String endDate)

Creates a DURATION period with the startDate and endDate Note: As dates are in ISO 8601 format, the date representation "2007-08-31" is assumed to be in the NO_TIMEZONE time zone. If you don't want this, you may specify a date in the format 2007-08-31+0100 or 2007-08-31T01:00:00.000+0000

Parameters:

dts - - DTSContainer

startDate - - Date string in ISO 8601 format

endDate - - Date string in ISO 8601 format

XBRLPeriod

public XBRLPeriod(DTSContainer dts,
                  java.lang.String instantDate)

Creates a INSTANT period with the instantDate Note: As dates are in ISO 8601 format, the date representation "2007-08-31" is assumed to be in the NO_TIMEZONE time zone. If you don't want this, you may specify a date in the format 2007-08-31+01:00 or 2007-08-31T01:00:00.000+00:00

Parameters:

dts - - DTSContainer

instantDate - - Date string in ISO 8601 format

XBRLPeriod

public XBRLPeriod(DTSContainer dts,
                  java.util.GregorianCalendar instant,
                  boolean bHasTimeZone,
                  boolean bHasTime)

Creates a INSTANT period with the instant date The date value will be set to the Gregorian Calendar used in the parameter.

Parameters:

dts - - DTSContainer

instant - - Gregorian Calendar

bHasTimeZone - the b has time zone

bHasTime - the b has time

XBRLPeriod

public XBRLPeriod(DTSContainer dts,
                  java.util.GregorianCalendar start,
                  java.util.GregorianCalendar end,
                  boolean bHasTimeZone,
                  boolean bHasTime)

Instantiates a new XBRL period.

Parameters:

dts - the dts

start - the start

end - the end

bHasTimeZone - the b has time zone

bHasTime - the b has time

Method Detail

getComparableDate

public java.util.GregorianCalendar getComparableDate()

Gets the comparable date.

Returns:

the comparable date

make

public static XBRLPeriod make(DTSContainer dts)

Make.

Parameters:

dts - the dts

Returns:

the com.ihr.xbrl.om.instance. XBRL period

clear

public void clear()
           throws java.lang.Throwable

Clear.

Overrides:

clear in class XMLFragment

Throws:

java.lang.Throwable - the throwable

clone

public XBRLPeriod clone()

Clone.

Overrides:

clone in class XMLFragment

Returns:

the XBRL period

clone

public XBRLPeriod clone(DTSContainer newDTS)

Clone.

Overrides:

clone in class XMLFragment

Parameters:

newDTS - the new DTS

Returns:

the XBRL period

getCalendarValue

public static net.sf.saxon.value.CalendarValue getCalendarValue(java.lang.CharSequence cs)
                                                         throws net.sf.saxon.trans.XPathException

Gets the calendar value.

Parameters:

cs - the cs

Returns:

the calendar value

Throws:

net.sf.saxon.trans.XPathException - the x path exception

getElementEndDate

public XMLFragment getElementEndDate()

Gets the element end date.

Returns:

the element end date

getElementStartDate

public XMLFragment getElementStartDate()

Gets the element start date.

Returns:

the element start date

getElementInstant

public XMLFragment getElementInstant()

Gets the element instant.

Returns:

the element instant

getElementForever

public XMLFragment getElementForever()

Gets the element forever.

Returns:

the element forever

getPeriodType

public XBRLItem.PeriodType getPeriodType()

Returns XBRLItem.DURATION or XBRLItem.INSTANT depending on the context period information. Forever periods are considered DURATION.

Returns:

XBRLItem.PeriodType

getFriendlyName

public java.lang.String getFriendlyName()

Gets the friendly name.

Overrides:

getFriendlyName in class XMLFragment

Returns:

the friendly name

getFriendlyName

public java.lang.String getFriendlyName(int use)

Gets the friendly name.

Overrides:

getFriendlyName in class XMLFragment

Parameters:

use - the use

Returns:

the friendly name

getFriendlyName

public java.lang.String getFriendlyName(int modifiers,
                                        LabelsProvider lp)

Gets the friendly name.

Overrides:

getFriendlyName in class XMLFragment

Parameters:

modifiers - the modifiers

lp - the lp

Returns:

the friendly name

isInstant

public boolean isInstant()

Checks if is instant.

Returns:

true if this period is of the XBRL instant type

isDuration

public boolean isDuration()

Checks if is duration.

Returns:

true if this period is of the XBRL duration type. Forever periods are duration

isForever

public boolean isForever()

Checks if is forever.

Returns:

true if this period is forever

getDate

public java.lang.String getDate(int type)

String representation of the date in the period. adjusted according to XBRL specification rules. That is, adding 24 hours to period end and instant dates and keeping the date on period start dates.

Parameters:

type - code indicating what to obtain. DATE_INSTANT, DATE_START or DATE_END

Returns:

String

getRawDate

public java.lang.String getRawDate(int type)

String representation of the date in the period. NOT adjusted according to XBRL specification rules. That is, not adding 24 hours to any date

Parameters:

type - code indicating what to obtain. DATE_INSTANT, DATE_START or DATE_END

Returns:

String

getGregorianCalendarDate

public java.util.GregorianCalendar getGregorianCalendarDate(int type)

Returns the value of the date for the type requested. returned values are adjusted according to XBRL specification rules Valid types are: XBRLPeriod.DATE_END XBRLPeriod.DATE_START XBRLPeriod.DATE_INSTANT

Parameters:

type - one of the constants below

Returns:

a GregorianCalendar

getRawGregorianCalendarDate

public java.util.GregorianCalendar getRawGregorianCalendarDate(int type)

Returns the value of the date for the type requested. NOT adjusted to XBRL interpretation. returned values are NOT adjusted according to XBRL specification rules Valid types are: XBRLPeriod.DATE_END XBRLPeriod.DATE_START XBRLPeriod.DATE_INSTANT

Parameters:

type - one of the constants below

Returns:

a GregorianCalendar

adjust24h

public static java.util.GregorianCalendar adjust24h(java.util.GregorianCalendar calendar,
                                                    boolean sign)

Adjust24h.

Parameters:

calendar - the calendar

sign - boolean (true) to add 24 hours (false) to substract 24 hours

Returns:

a new GregorianCalendar object. The original object is not modified

validate

public XBRLValidationReport validate()

Produces a XBRLValidationReport object for this period object.

Returns:

XBRLValidationReport

equals

public boolean equals(java.lang.Object other)

Equals.

Specified by:

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

Overrides:

equals in class XMLFragment

Parameters:

other - the other

Returns:

true, if successful

s_equal2

public boolean s_equal2(java.lang.Object other)

S equal 2.

Overrides:

s_equal2 in class XMLFragment

Parameters:

other - the other

Returns:

true, if successful

hashCode

public int hashCode()

Hash code.

Specified by:

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

Overrides:

hashCode in class XMLFragment

Returns:

the int

generateNode

public XMLFragment generateNode()
                         throws XBRLSerializationException

Generate node.

Overrides:

generateNode in class XMLFragment

Returns:

the XML fragment

Throws:

XBRLSerializationException - the XBRL serialization exception

iso8601

public static java.lang.String iso8601(java.util.GregorianCalendar c,
                                       boolean hasTimezone,
                                       boolean hasTime)

Returns a string representation in iso8601 standard with the value of variable c yyyy-MM-dd'T'HH:mm:ss.SSSZ is the complete patters that can be used some parts of this pattern can be omited according to the values of hasTimezone and hasTime below. By default only yyy-MM-dd is used. if hasTime is true, then 'T'HH:mm:ss.SSS" is added if hasTimezone is true, then Z is added

Parameters:

c - GregorianCalendar

hasTimezone - boolean value, true means c has time zone information

hasTime - boolean value, true means c has time information

Returns:

String

iso8601

public static java.util.GregorianCalendar iso8601(java.lang.String value,
                                                  boolean bAdd24h)

Converts a string of the format yyyy-MM-dd to the apropriate GregorianCalendar object. Returns null if there are errors in the string

Parameters:

value - string in the format yyyy-MM-dd

bAdd24h - for period end dates this must be set to true

Returns:

GregorianCalendar

setDate

public void setDate(int type,
                    java.lang.String strDate)
             throws XBRLValidationException

Sets the value of the specified field.

Parameters:

type - this is the field, DATE_END, DATE_INSTANT, DATE_START

strDate - iso8601 date string

Throws:

XBRLValidationException - the XBRL validation exception

getRawDateUtil

public java.util.Date getRawDateUtil(int code)

Returns the raw date (the one specified by syntax) in the context. "raw" means no +1PD will be assumed for instance dates or endDate dates The return value is a Date in this case.

Parameters:

code - this is the field, DATE_END, DATE_INSTANT, DATE_START

Returns:

a java.util.Date

getLocalizedPeriodType

public java.lang.String getLocalizedPeriodType()

Returns a localized string representing the period type. this is, in English "instant" or "duration". Forever contexts are returned as duration.

Returns:

localized string

getLocalizedPeriodType

public static java.lang.String getLocalizedPeriodType(XBRLItem.PeriodType periodType)

Returns a localized string representing the period type. this is, in English "instant" or "duration". Forever contexts are returned as duration.

Parameters:

periodType - constant indicating XBRLItem.INSTANT or XBRLItem.DURATION

Returns:

localized string

isHasDateAndTime

public boolean isHasDateAndTime()

Returns true if the date contains date and time. In case of instant only the instance date is considered. In case of duration, this returns true if any or both of the dates has date and time information.

Returns:

boolean value

isHasTimeZone

public boolean isHasTimeZone()

Returns true if the date contains time zone. In case of instant only the instance date is considered. In case of duration, this returns true if any or both of the dates has time zone.

Returns:

boolean value

setForever

public void setForever()

Change this period to a <forever/> period. If the period is instant or duration the information is lost

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