Package org.rumbledb.items

Class YearMonthDurationItem

java.lang.Object

org.rumbledb.items.AbstractAtomicItem

org.rumbledb.items.YearMonthDurationItem

All Implemented Interfaces:

Serializable, Item

public class YearMonthDurationItem
extends AbstractAtomicItem

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
YearMonthDurationItem(String value)
YearMonthDurationItem(Period value)

Method Summary

Modifier and Type	Method	Description
Item	copy(boolean mutable)	Makes a copy.
int	getDay()	Return only day of the item, if it's DateTime or Duration It will not convert months and years into days.
Duration	getDayTimeDurationComponent()	Returns the day-time (seconds) component of a duration item, i.e., the value of the duration excluding its months component.
Duration	getDurationValue()	Returns the duration value of the item, if it is a duration.
ItemType	getDynamicType()	Returns the dynamic type of the item (only for error message purposes).
boolean	getEffectiveBooleanValue()	Returns the effective boolean value of the item, if atomic.
long	getEpochMillis()	Returns the EpochMillis of the item, if it's DateTime or Duration It will collect all the parts of the item and compress it into the EpochMillis
int	getHour()	Return only hour of the item, if it's DateTime, Time or Duration
int	getMinute()	Return only minutes of the item, if it's DateTime, Time or Duration It will not convert hours into minutes
int	getMonth()	Return only month of the item, if it's DateTime or Duration It will not convert years into months
Period	getPeriodValue()	Returns the period value of the item, if it is a duration.
double	getSecond()	Return only seconds of the item, if it's DateTime, Time or Duration It will not convert hours and minutes into seconds
String	getStringValue()	Returns the string value of the item, if it is an atomic item.
int	getYear()	Return year of the item, if it's DateTime or Duration
boolean	isAtomic()	Tests whether the item is an atomic item.
boolean	isDuration()	Tests whether the item is an atomic item of type duration.
boolean	isYearMonthDuration()	Tests whether the item is an atomic item of type yearMonthDuration.
static String	normalizeDuration(Period period)
static Period	normalizeMonthsToYears(Period period)

Methods inherited from class org.rumbledb.items.AbstractAtomicItem

equals, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.rumbledb.api.Item

addOrReplaceNamespace, addParentToDescendants, appendItem, appendSequence, atomizedValue, attributes, baseUri, castToDecimalValue, castToDoubleValue, castToFloatValue, castToIntegerValue, castToIntValue, children, clearSchemaType, declaredNamespaceNodes, documentUri, generateNativeQuery, getBinaryValue, getBodyIterator, getBooleanValue, getCollection, getContent, getDateTimeValue, getDecimalValue, getDFVariablesInClosure, getDoubleValue, getEstimator, getFloatValue, getIdentifier, getIntegerValue, getIntValue, getItemAt, getItemByKey, getItemByKey, getItemKeys, getItemMembers, getItemValues, getLocalVariablesInClosure, getModuleDynamicContext, getMutabilityLevel, getNanosecond, getNotationValue, getOffset, getParameterNames, getPathIn, getQNameValue, getRDDVariablesInClosure, getSchemaTypeAnnotation, getSequenceAt, getSequenceByKey, getSequenceByKey, getSequenceMembers, getSequenceValues, getSignature, getSize, getSparkSQLType, getSparkSQLValue, getSparkSQLValue, getStringKeys, getTableLocation, getTextValue, getTimeValue, getTopLevelID, getTopLevelOrder, getTransformer, getVariantValue, getXmlDocumentPosition, hasDateTime, hasKey, hasKey, hasTimeZone, isAnyURI, isArray, isArrayOfItems, isAttributeNode, isBase64Binary, isBinary, isBoolean, isBuiltinFunction, isCommentNode, isDate, isDateTime, isDayTimeDuration, isDecimal, isDocumentNode, isDouble, isElementNode, isEstimator, isFloat, isFunction, isGDay, isGMonth, isGMonthDay, isGYear, isGYearMonth, isHexBinary, isId, isIdrefs, isInt, isInteger, isMap, isNamespaceNode, isNaN, isNode, isNotation, isNull, isNumeric, isObject, isPeriod, isProcessingInstructionNode, isQName, isString, isTextNode, isTime, isTransformer, isUntypedAtomic, namespaceNodes, nilled, nodeKind, nodeName, parent, physicalEquals, putItemAt, putItemByKey, putItemByKey, putItemsAt, putLazyItemByKey, putSequenceAt, putSequenceByKey, putSequenceByKey, putSequencesAt, removeItemAt, removeItemByKey, removeItemByKey, removeSequenceAt, serialize, serializeAsJSON, setCollection, setMutabilityLevel, setParent, setPathIn, setSchemaType, setSchemaType, setTableLocation, setTopLevelID, setTopLevelOrder, setXmlDocumentPosition, setXmlSchemaIdentityProperties, setXmlSchemaNilled, typedValue, typeName, unparsedEntityPublicId, unparsedEntitySystemId

Constructor Details

YearMonthDurationItem

public YearMonthDurationItem(Period value)

YearMonthDurationItem

public YearMonthDurationItem(String value)

Method Details

copy

public Item copy(boolean mutable)

Description copied from interface: Item

Makes a copy.

Parameters:

mutable - whether the copy should be mutable (if supported by the item).

Returns:

a copy

isYearMonthDuration

public boolean isYearMonthDuration()

Description copied from interface: Item

Tests whether the item is an atomic item of type yearMonthDuration.

Returns:

true if it is an atomic item of type yearMonthDuration, false otherwise.

isAtomic

public boolean isAtomic()

Description copied from interface: Item

Tests whether the item is an atomic item.

Returns:

true if it is an atomic item, false otherwise.

isDuration

public boolean isDuration()

Description copied from interface: Item

Tests whether the item is an atomic item of type duration.

Returns:

true if it is an atomic item of type duration, false otherwise.

getEffectiveBooleanValue

public boolean getEffectiveBooleanValue()

Description copied from interface: Item

Returns the effective boolean value of the item, if atomic.

Returns:

the effective boolean value.

getStringValue

public String getStringValue()

Description copied from interface: Item

Returns the string value of the item, if it is an atomic item.

Returns:

the string value.

getDynamicType

public ItemType getDynamicType()

Description copied from interface: Item

Returns the dynamic type of the item (only for error message purposes).

Returns:

the dynamic type as an item type.

getDurationValue

public Duration getDurationValue()

Description copied from interface: Item

Returns the duration value of the item, if it is a duration.

Returns:

the duration value as a Duration.

getPeriodValue

public Period getPeriodValue()

Description copied from interface: Item

Returns the period value of the item, if it is a duration.

Returns:

the period value as a Period.

getDayTimeDurationComponent

public Duration getDayTimeDurationComponent()

Description copied from interface: Item

Returns the day-time (seconds) component of a duration item, i.e., the value of the duration excluding its months component. Unlike getDurationValue(), this is not anchored to any reference date, since days, hours, minutes and seconds have a fixed length and can be converted to a Duration unambiguously.

Returns:

the day-time component as a Duration.

getEpochMillis

public long getEpochMillis()

Description copied from interface: Item

Returns the EpochMillis of the item, if it's DateTime or Duration It will collect all the parts of the item and compress it into the EpochMillis

Returns:

the EpochMillis

normalizeDuration

public static String normalizeDuration(Period period)

normalizeMonthsToYears

public static Period normalizeMonthsToYears(Period period)

getYear

public int getYear()

Description copied from interface: Item

Return year of the item, if it's DateTime or Duration

Returns:

year

getMonth

public int getMonth()

Description copied from interface: Item

Return only month of the item, if it's DateTime or Duration It will not convert years into months

Returns:

only month

getDay

public int getDay()

Description copied from interface: Item

Return only day of the item, if it's DateTime or Duration It will not convert months and years into days.

Returns:

only day

getHour

public int getHour()

Description copied from interface: Item

Return only hour of the item, if it's DateTime, Time or Duration

Returns:

only hour

getMinute

public int getMinute()

Description copied from interface: Item

Return only minutes of the item, if it's DateTime, Time or Duration It will not convert hours into minutes

Returns:

only minute

getSecond

public double getSecond()

Description copied from interface: Item

Return only seconds of the item, if it's DateTime, Time or Duration It will not convert hours and minutes into seconds

Returns:

only seconds