org.apache.spark.ml.attribute

Class AttributeGroup

java.lang.Object

org.apache.spark.ml.attribute.AttributeGroup

All Implemented Interfaces:

java.io.Serializable

public class AttributeGroup
extends java.lang.Object
implements scala.Serializable

:: DeveloperApi :: Attributes that describe a vector ML column.

param: name name of the attribute group (the ML column name) param: numAttributes optional number of attributes. At most one of numAttributes and attrs can be defined. param: attrs optional array of attributes. Attribute will be copied with their corresponding indices in the array.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AttributeGroup(java.lang.String name) Creates an attribute group without attribute info.
AttributeGroup(java.lang.String name, Attribute[] attrs) Creates an attribute group with attributes.
AttributeGroup(java.lang.String name, int numAttributes) Creates an attribute group knowing only the number of attributes.

Method Summary

Methods

Modifier and Type	Method and Description
Attribute	apply(int attrIndex) Gets an attribute by its index.
Attribute	apply(java.lang.String attrName) Gets an attribute by its name.
scala.Option<Attribute[]>	attributes() Optional array of attributes.
boolean	equals(java.lang.Object other)
static AttributeGroup	fromStructField(StructField field) Creates an attribute group from a StructField instance.
Attribute	getAttr(int attrIndex) Gets an attribute by its index.
Attribute	getAttr(java.lang.String attrName) Gets an attribute by its name.
boolean	hasAttr(java.lang.String attrName) Test whether this attribute group contains a specific attribute.
int	hashCode()
int	indexOf(java.lang.String attrName) Index of an attribute specified by name.
java.lang.String	name()
scala.Option<java.lang.Object>	numAttributes()
int	size() Size of the attribute group.
Metadata	toMetadata() Converts to ML metadata
Metadata	toMetadata(Metadata existingMetadata) Converts to ML metadata with some existing metadata.
StructField	toStructField() Converts to a StructField.
StructField	toStructField(Metadata existingMetadata) Converts to a StructField with some existing metadata.

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributeGroup

public AttributeGroup(java.lang.String name)

Creates an attribute group without attribute info.

Parameters:

name - name of the attribute group

AttributeGroup

public AttributeGroup(java.lang.String name,
              int numAttributes)

Creates an attribute group knowing only the number of attributes.

Parameters:

name - name of the attribute group

numAttributes - number of attributes

AttributeGroup

public AttributeGroup(java.lang.String name,
              Attribute[] attrs)

Creates an attribute group with attributes.

Parameters:

name - name of the attribute group

attrs - array of attributes. Attributes will be copied with their corresponding indices in the array.

Method Detail

fromStructField

public static AttributeGroup fromStructField(StructField field)

Creates an attribute group from a StructField instance.

name

public java.lang.String name()

numAttributes

public scala.Option<java.lang.Object> numAttributes()

attributes

public scala.Option<Attribute[]> attributes()

Optional array of attributes. At most one of numAttributes and attributes can be defined.

Returns:

(undocumented)

size

public int size()

Size of the attribute group. Returns -1 if the size is unknown.

hasAttr

public boolean hasAttr(java.lang.String attrName)

Test whether this attribute group contains a specific attribute.

indexOf

public int indexOf(java.lang.String attrName)

Index of an attribute specified by name.

apply

public Attribute apply(java.lang.String attrName)

Gets an attribute by its name.

getAttr

public Attribute getAttr(java.lang.String attrName)

Gets an attribute by its name.

apply

public Attribute apply(int attrIndex)

Gets an attribute by its index.

getAttr

public Attribute getAttr(int attrIndex)

Gets an attribute by its index.

toMetadata

public Metadata toMetadata(Metadata existingMetadata)

Converts to ML metadata with some existing metadata.

toMetadata

public Metadata toMetadata()

Converts to ML metadata

toStructField

public StructField toStructField(Metadata existingMetadata)

Converts to a StructField with some existing metadata.

toStructField

public StructField toStructField()

Converts to a StructField.

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object