smile.data.type

Class StructType

java.lang.Object

smile.data.type.StructType

All Implemented Interfaces:

java.io.Serializable, DataType

public class StructType
extends java.lang.Object
implements DataType

Struct data type is determined by the fixed order of the fields of primitive data types in the struct. An instance of a struct type will be a tuple.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface smile.data.type.DataType

DataType.ID

Field Summary

Fields inherited from interface smile.data.type.DataType

BooleanPattern, DatePattern, DateTimePattern, DoublePattern, IntPattern, LongPattern, TimePattern

Constructor Summary

Constructors

Constructor and Description
StructType(java.util.List<StructField> fields) Constructor.
StructType(StructField... fields) Constructor.

Method Summary

Modifier and Type	Method and Description
StructType	boxed(java.util.Collection<Tuple> rows) Updates the field type to the boxed one if the field has null/missing values in the data.
boolean	equals(java.lang.Object o)
StructField	field(int i) Return the field at position i.
StructField	field(java.lang.String name) Return the field of given name.
int	fieldIndex(java.lang.String field) Returns the index of a field.
java.lang.String	fieldName(int i) Returns the name of a field.
StructField[]	fields() Returns the fields.
DataType.ID	id() Returns the type ID enum.
int	length() Returns the number of fields.
java.lang.String	name() Returns the type name used in external catalogs.
java.util.List<java.util.function.Function<java.lang.String,java.lang.Object>>	parser() Returns the lambda functions that parse field values.
java.lang.String	toString()
java.lang.String	toString(java.lang.Object o) Returns the string representation of a value of the type.
StructType	unboxed() Updates the field type to the primitive one.
Tuple	valueOf(java.lang.String s) Returns the value from its string representation.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface smile.data.type.DataType

boxed, coerce, infer, isBoolean, isByte, isChar, isDouble, isDouble, isFloat, isFloat, isFloating, isInt, isInt, isIntegral, isLong, isLong, isNumeric, isObject, isPrimitive, isShort, isString, of, of, of, prompt

Constructor Detail

StructType

public StructType(java.util.List<StructField> fields)

Constructor.

StructType

public StructType(StructField... fields)

Constructor.

Method Detail

length

public int length()

Returns the number of fields.

fields

public StructField[] fields()

Returns the fields.

field

public StructField field(java.lang.String name)

Return the field of given name.

field

public StructField field(int i)

Return the field at position i.

fieldIndex

public int fieldIndex(java.lang.String field)

Returns the index of a field.

fieldName

public java.lang.String fieldName(int i)

Returns the name of a field.

parser

public java.util.List<java.util.function.Function<java.lang.String,java.lang.Object>> parser()

Returns the lambda functions that parse field values.

boxed

public StructType boxed(java.util.Collection<Tuple> rows)

Updates the field type to the boxed one if the field has null/missing values in the data.

Parameters:

rows - a set of tuples.

unboxed

public StructType unboxed()

Updates the field type to the primitive one.

Specified by:

unboxed in interface DataType

name

public java.lang.String name()

Description copied from interface: DataType

Returns the type name used in external catalogs. DataType.of(name()) should returns the same type.

Specified by:

name in interface DataType

id

public DataType.ID id()

Description copied from interface: DataType

Returns the type ID enum.

Specified by:

id in interface DataType

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(java.lang.Object o)

Description copied from interface: DataType

Returns the string representation of a value of the type.

Specified by:

toString in interface DataType

valueOf

public Tuple valueOf(java.lang.String s)

Description copied from interface: DataType

Returns the value from its string representation.

Specified by:

valueOf in interface DataType

Parameters:

s - the string representation of a value of this type.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object