Package org.rumbledb.items

Class StringItem

java.lang.Object

org.rumbledb.items.AbstractAtomicItem

org.rumbledb.items.StringItem

All Implemented Interfaces:

Serializable, Item

public class StringItem
extends AbstractAtomicItem

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
StringItem(String value)

Method Summary

Modifier and Type	Method	Description
BigDecimal	castToDecimalValue()	Casts the item to a decimal value (must be a numeric).
double	castToDoubleValue()	Casts the item to a double value (must be a numeric).
float	castToFloatValue()	Casts the item to a float value (must be a numeric).
BigInteger	castToIntegerValue()	Casts the item to a big integer value (must be a numeric).
int	castToIntValue()	Casts the item to an integer value (must be a numeric).
Item	copy(boolean mutable)	Makes a copy.
NativeClauseContext	generateNativeQuery(NativeClauseContext context)	Get sparkSql string for the item
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	getSparkSQLType()	Returns the SparkSQL type of the item for use in a query.
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	isString()	Tests whether the item is an atomic item of type string.

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, children, clearSchemaType, declaredNamespaceNodes, documentUri, 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, 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, isNull, isNumeric, isObject, isPeriod, isProcessingInstructionNode, isQName, 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

StringItem

public StringItem(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

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.

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.

castToDoubleValue

public double castToDoubleValue()

Description copied from interface: Item

Casts the item to a double value (must be a numeric).

Returns:

the double value.

castToFloatValue

public float castToFloatValue()

Description copied from interface: Item

Casts the item to a float value (must be a numeric).

Returns:

the float value.

castToDecimalValue

public BigDecimal castToDecimalValue()

Description copied from interface: Item

Casts the item to a decimal value (must be a numeric).

Returns:

the BigDecimal value.

castToIntegerValue

public BigInteger castToIntegerValue()

Description copied from interface: Item

Casts the item to a big integer value (must be a numeric).

Returns:

the BigInteger value.

castToIntValue

public int castToIntValue()

Description copied from interface: Item

Casts the item to an integer value (must be a numeric).

Returns:

the int value.

isString

public boolean isString()

Description copied from interface: Item

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

Returns:

true if it is an atomic item of type string, 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.

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.

generateNativeQuery

public NativeClauseContext generateNativeQuery(NativeClauseContext context)

Description copied from interface: Item

Get sparkSql string for the item

Parameters:

context - input context

Returns:

String representing the item in a sparksql query or null if it is not supported for the item

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.

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.

getSparkSQLType

public String getSparkSQLType()

Description copied from interface: Item

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

Returns:

String representing the SparkSQL type of the item.