Package org.rumbledb.items

Class NullItem

java.lang.Object

org.rumbledb.items.AbstractAtomicItem

org.rumbledb.items.NullItem

All Implemented Interfaces:

Serializable, Item

public class NullItem
extends AbstractAtomicItem

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
NullItem()

Method Summary

Modifier and Type	Method	Description
Item	copy(boolean mutable)	Makes a copy.
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.
String	getSparkSQLValue()	Returns the SparkSQL value of the item for use in a query.
String	getSparkSQLValue(ItemType itemType)	Returns the SparkSQL value of the item for use in a query.
String	getStringValue()	Returns the string value of the item, if it is an atomic item.
Object	getVariantValue()	Returns the Object containing the converted value of the item for a DataFrame.
boolean	isAtomic()	Tests whether the item is an atomic item.
boolean	isNull()	Tests whether the item is the null item.

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, getDay, getDayTimeDurationComponent, getDecimalValue, getDFVariablesInClosure, getDoubleValue, getDurationValue, getEpochMillis, getEstimator, getFloatValue, getHour, getIdentifier, getIntegerValue, getIntValue, getItemAt, getItemByKey, getItemByKey, getItemKeys, getItemMembers, getItemValues, getLocalVariablesInClosure, getMinute, getModuleDynamicContext, getMonth, getMutabilityLevel, getNanosecond, getNotationValue, getOffset, getParameterNames, getPathIn, getPeriodValue, getQNameValue, getRDDVariablesInClosure, getSchemaTypeAnnotation, getSecond, getSequenceAt, getSequenceByKey, getSequenceByKey, getSequenceMembers, getSequenceValues, getSignature, getSize, getSparkSQLType, getStringKeys, getTableLocation, getTextValue, getTimeValue, getTopLevelID, getTopLevelOrder, getTransformer, getXmlDocumentPosition, getYear, hasDateTime, hasKey, hasKey, hasTimeZone, isAnyURI, isArray, isArrayOfItems, isAttributeNode, isBase64Binary, isBinary, isBoolean, isBuiltinFunction, isCommentNode, isDate, isDateTime, isDayTimeDuration, isDecimal, isDocumentNode, isDouble, isDuration, isElementNode, isEstimator, isFloat, isFunction, isGDay, isGMonth, isGMonthDay, isGYear, isGYearMonth, isHexBinary, isId, isIdrefs, isInt, isInteger, isMap, isNamespaceNode, isNaN, isNode, isNotation, isNumeric, isObject, isPeriod, isProcessingInstructionNode, isQName, isString, isTextNode, isTime, isTransformer, isUntypedAtomic, isYearMonthDuration, 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

NullItem

public NullItem()

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

isNull

public boolean isNull()

Description copied from interface: Item

Tests whether the item is the null item.

Returns:

true if it is the null item, false otherwise.

getVariantValue

public Object getVariantValue()

Description copied from interface: Item

Returns the Object containing the converted value of the item for a DataFrame. For use to build Variant columns.

Returns:

Object representing the converted value of the item.

getEffectiveBooleanValue

public boolean getEffectiveBooleanValue()

Description copied from interface: Item

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

Returns:

the effective boolean 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.

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.

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.

getSparkSQLValue

public String getSparkSQLValue()

Description copied from interface: Item

Returns the SparkSQL value of the item for use in a query.

Returns:

String representing the SparkSQL value of the item.

getSparkSQLValue

public String getSparkSQLValue(ItemType itemType)

Description copied from interface: Item

Returns the SparkSQL value of the item for use in a query.

Returns:

String representing the SparkSQL value of the item.