Record Class Row

java.lang.Object

java.lang.Record

smile.data.Row

Record Components:

df - the data frame that the row belongs to.

index - the row index.

All Implemented Interfaces:

Serializable, Tuple

public record Row(DataFrame df, int index)
extends Record
implements Tuple

A row in data frame.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Row(DataFrame df, int index)	Creates an instance of a Row record class.

Method Summary

Modifier and Type	Method	Description
DataFrame	df()	Returns the value of the df record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Object	get(int j)	Returns the value at position i.
boolean	getBoolean(int j)	Returns the value at position i as a primitive boolean.
byte	getByte(int j)	Returns the value at position i as a primitive byte.
char	getChar(int j)	Returns the value at position i as a primitive byte.
double	getDouble(int j)	Returns the value at position i as a primitive double.
float	getFloat(int j)	Returns the value at position i as a primitive float.
int	getInt(int j)	Returns the value at position i as a primitive int.
long	getLong(int j)	Returns the value at position i as a primitive long.
short	getShort(int j)	Returns the value at position i as a primitive short.
final int	hashCode()	Returns a hash code value for this object.
int	index()	Returns the value of the index record component.
boolean	isNullAt(int j)	Checks whether the value at the given position is null.
boolean	isNullAt(String field)	Checks whether the field value is null.
StructType	schema()	Returns the schema of tuple.
String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Methods inherited from interface Tuple

anyNull, apply, apply, get, getArray, getArray, getAs, getAs, getBoolean, getByte, getChar, getDate, getDate, getDateTime, getDateTime, getDecimal, getDecimal, getDouble, getFloat, getInt, getLong, getScale, getScale, getShort, getString, getString, getStruct, getStruct, getTime, getTime, indexOf, length, toArray, toArray, toString, toString

Constructor Details

Row

public Row(DataFrame df,
 int index)

Creates an instance of a Row record class.

Parameters:

df - the value for the df record component

index - the value for the index record component

Method Details

toString

public String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

schema

public StructType schema()

Description copied from interface: Tuple

Returns the schema of tuple.

Specified by:

schema in interface Tuple

Returns:

the schema of tuple.

isNullAt

public boolean isNullAt(int j)

Description copied from interface: Tuple

Checks whether the value at the given position is null.

Specified by:

isNullAt in interface Tuple

Parameters:

j - the index of field.

Returns:

true if the field value is null.

isNullAt

public boolean isNullAt(String field)

Description copied from interface: Tuple

Checks whether the field value is null.

Specified by:

isNullAt in interface Tuple

Parameters:

field - the name of field.

Returns:

true if the field value is null.

get

public Object get(int j)

Description copied from interface: Tuple

Returns the value at position i. The value may be null.

Specified by:

get in interface Tuple

Parameters:

j - the index of field.

Returns:

the field value.

getBoolean

public boolean getBoolean(int j)

Description copied from interface: Tuple

Returns the value at position i as a primitive boolean.

Specified by:

getBoolean in interface Tuple

Parameters:

j - the index of field.

Returns:

the field value.

getChar

public char getChar(int j)

Description copied from interface: Tuple

Returns the value at position i as a primitive byte.

Specified by:

getChar in interface Tuple

Parameters:

j - the index of field.

Returns:

the field value.

getByte

public byte getByte(int j)

Description copied from interface: Tuple

Returns the value at position i as a primitive byte.

Specified by:

getByte in interface Tuple

Parameters:

j - the index of field.

Returns:

the field value.

getShort

public short getShort(int j)

Description copied from interface: Tuple

Returns the value at position i as a primitive short.

Specified by:

getShort in interface Tuple

Parameters:

j - the index of field.

Returns:

the field value.

getInt

public int getInt(int j)

Description copied from interface: Tuple

Returns the value at position i as a primitive int.

Specified by:

getInt in interface Tuple

Parameters:

j - the index of field.

Returns:

the field value.

getLong

public long getLong(int j)

Description copied from interface: Tuple

Returns the value at position i as a primitive long.

Specified by:

getLong in interface Tuple

Parameters:

j - the index of field.

Returns:

the field value.

getFloat

public float getFloat(int j)

Description copied from interface: Tuple

Returns the value at position i as a primitive float. Throws an exception if the type mismatches or if the value is null.

Specified by:

getFloat in interface Tuple

Parameters:

j - the index of field.

Returns:

the field value.

getDouble

public double getDouble(int j)

Description copied from interface: Tuple

Returns the value at position i as a primitive double.

Specified by:

getDouble in interface Tuple

Parameters:

j - the index of field.

Returns:

the field value.

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

df

public DataFrame df()

Returns the value of the df record component.

Returns:

the value of the df record component

index

public int index()

Returns the value of the index record component.

Returns:

the value of the index record component