org.apache.spark.sql.types

Class MapType

java.lang.Object

org.apache.spark.sql.types.DataType

org.apache.spark.sql.types.MapType

All Implemented Interfaces:

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

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

:: DeveloperApi :: The data type for Maps. Keys in a map are not allowed to have null values.

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

param: keyType The data type of map keys. param: valueType The data type of map values. param: valueContainsNull Indicates if map values have null values.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MapType() No-arg constructor for kryo.
MapType(DataType keyType, DataType valueType, boolean valueContainsNull)

Method Summary

Methods

Modifier and Type	Method and Description
static MapType	apply(DataType keyType, DataType valueType) Construct a MapType object with the given key type and value type.
abstract static boolean	canEqual(java.lang.Object that)
static java.lang.String	catalogString()
int	defaultSize() The default size of a value of the MapType is 100 * (the default size of the key type + the default size of the value type).
abstract static boolean	equals(java.lang.Object that)
static java.lang.String	json()
DataType	keyType()
static java.lang.String	prettyJson()
abstract static int	productArity()
abstract static java.lang.Object	productElement(int n)
static scala.collection.Iterator<java.lang.Object>	productIterator()
static java.lang.String	productPrefix()
java.lang.String	simpleString() Readable string representation for the type.
java.lang.String	sql()
static java.lang.String	typeName()
boolean	valueContainsNull()
DataType	valueType()

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

buildFormattedString, catalogString, fromJson, json, prettyJson, typeName

Methods inherited from class java.lang.Object

clone, equals, finalize, 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

MapType

public MapType(DataType keyType,
       DataType valueType,
       boolean valueContainsNull)

MapType

public MapType()

No-arg constructor for kryo.

Method Detail

apply

public static MapType apply(DataType keyType,
            DataType valueType)

Construct a MapType object with the given key type and value type. The valueContainsNull is true.

Parameters:

keyType - (undocumented)

valueType - (undocumented)

Returns:

(undocumented)

typeName

public static java.lang.String typeName()

json

public static java.lang.String json()

prettyJson

public static java.lang.String prettyJson()

catalogString

public static java.lang.String catalogString()

canEqual

public abstract static boolean canEqual(java.lang.Object that)

equals

public abstract static boolean equals(java.lang.Object that)

productElement

public abstract static java.lang.Object productElement(int n)

productArity

public abstract static int productArity()

productIterator

public static scala.collection.Iterator<java.lang.Object> productIterator()

productPrefix

public static java.lang.String productPrefix()

keyType

public DataType keyType()

valueType

public DataType valueType()

valueContainsNull

public boolean valueContainsNull()

defaultSize

public int defaultSize()

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

Specified by:

defaultSize in class DataType

Returns:

(undocumented)

simpleString

public java.lang.String simpleString()

Description copied from class: DataType

Readable string representation for the type.

Overrides:

simpleString in class DataType

sql

public java.lang.String sql()

Overrides:

sql in class DataType