org.apache.spark.sql.types

Class ArrayType

Object

org.apache.spark.sql.types.DataType

org.apache.spark.sql.types.ArrayType

All Implemented Interfaces:

java.io.Serializable, scala.Equals, scala.Product

public class ArrayType
extends DataType
implements scala.Product, scala.Serializable

:: DeveloperApi :: The data type for collections of multiple values. Internally these are represented as columns that contain a scala.collection.Seq.

Please use DataTypes.createArrayType() to create a specific instance.

An ArrayType object comprises two fields, elementType: DataType and containsNull: Boolean. The field of elementType is used to specify the type of array elements. The field of containsNull is used to specify if the array has null values.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ArrayType(DataType elementType, boolean containsNull)

Method Summary

Methods

Modifier and Type	Method and Description
static ArrayType	apply(DataType elementType) Construct a ArrayType object with the given element type.
ArrayType	asNullable() Returns the same data type but set all nullability fields are true (StructField.nullable, ArrayType.containsNull, and MapType.valueContainsNull).
void	buildFormattedString(String prefix, scala.collection.mutable.StringBuilder builder)
boolean	containsNull()
int	defaultSize() The default size of a value of the ArrayType is 100 * the default size of the element type.
DataType	elementType()
org.json4s.JsonAST.JObject	jsonValue()
String	simpleString()

Methods inherited from class org.apache.spark.sql.types.DataType

equalsIgnoreCompatibleNullability, equalsIgnoreNullability, fromCaseClassString, fromJson, isPrimitive, json, prettyJson, sameType, typeName, unapply

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface scala.Product

productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

ArrayType

public ArrayType(DataType elementType,
         boolean containsNull)

Method Detail

apply

public static ArrayType apply(DataType elementType)

Construct a ArrayType object with the given element type. The `containsNull` is true.

elementType

public DataType elementType()

containsNull

public boolean containsNull()

buildFormattedString

public void buildFormattedString(String prefix,
                        scala.collection.mutable.StringBuilder builder)

jsonValue

public org.json4s.JsonAST.JObject jsonValue()

Overrides:

jsonValue in class DataType

defaultSize

public int defaultSize()

The default size of a value of the ArrayType is 100 * the default size of the element type. (We assume that there are 100 elements).

Specified by:

defaultSize in class DataType

simpleString

public String simpleString()

Overrides:

simpleString in class DataType

asNullable

public ArrayType asNullable()

Description copied from class: DataType

Returns the same data type but set all nullability fields are true (StructField.nullable, ArrayType.containsNull, and MapType.valueContainsNull).

Specified by:

asNullable in class DataType