oracle.dmt.odm.data
Class MiningAttribute

java.lang.Object
  |
  +--oracle.dmt.odm.MiningObject
        |
        +--oracle.dmt.odm.data.Attribute
              |
              +--oracle.dmt.odm.data.MiningAttribute

All Implemented Interfaces:

java.io.Serializable

public class MiningAttribute

extends Attribute

An instance of MiningAttribute is a logical concept that describes a domain of data to be used as input to data mining operations. Mining attributes are typically either categorical or numerical. Each mining attribute must have a unique name with a given LogicalDataSpecification instance.

Since:

9.0.1

See Also:

Serialized Form

Constructor Summary

MiningAttribute(java.lang.String name, DataType dataType, AttributeType attributeType)
Creates a new MiningAttribute instance with the specified name, data type and attribute type.

Method Summary

boolean	equals(MiningAttribute attribute) Checks the equality of this attribute against the specified attribute.
AttributeType	getAttributeType() Returns the type of this attribute.
CategorySet	getCategorySet() Returns CategorySet associated with this mining attribute.
SparsitySpecification	getSparsitySpecification() Returns SparsitySpecification associated with an attribute.
int	getValueCount() Deprecated. As of ODM 9.2.0, distinct values are not counted.
void	setAttributeType(AttributeType attributeType) Sets the attribute type.
void	setCategorySet(CategorySet categorySet) Sets CategorySet for the mining attribute.
void	setSparsitySpecification(SparsitySpecification sparsitySpec) Sets SparsitySpecification associated with an attribute.

Methods inherited from class oracle.dmt.odm.data.Attribute

equals, getDataType, getName, setDataType

Methods inherited from class java.lang.Object

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

Constructor Detail

MiningAttribute

public MiningAttribute(java.lang.String name,
DataType dataType,
AttributeType attributeType)
                throws InvalidArgumentException,
ODMException

Creates a new MiningAttribute instance with the specified name, data type and attribute type.

Parameters:

name - The name of the attribute

dataType - The data type of the attribute (e.g., int)

attributeType - The type of the attribute (e.g., categorical)

Throws:

InvalidArgumentException -

• when name, dataType, or attributeType is null, or
• when name is null, empty or exceeds 30 bytes in length.

ODMException

Since:

9.2.0

Method Detail

getValueCount

public int getValueCount()

Deprecated. As of ODM 9.2.0, distinct values are not counted.

Returns the number of distinct values in this attribute

Returns:

int - The number of distinct values

getAttributeType

public AttributeType getAttributeType()

Returns the type of this attribute.

Returns:

AttributeType - The type of this attribute

See Also:

AttributeType

equals

public boolean equals(MiningAttribute attribute)

Checks the equality of this attribute against the specified attribute. Two mining attributes are equal if they have the same name, data type, and attribute type.

Parameters:

attribute - An attribute to be compared

Returns:

true if equal, false otherwise

setAttributeType

public void setAttributeType(AttributeType attributeType)

Sets the attribute type.

Parameters:

attributeType - attribute type

See Also:

AttributeType

getCategorySet

public CategorySet getCategorySet()

Returns CategorySet associated with this mining attribute. CategorySet will be null for numerical attributes.

Returns:

category set

Since:

10.1.0

setCategorySet

public void setCategorySet(CategorySet categorySet)
                    throws ODMException,
InvalidArgumentException

Sets CategorySet for the mining attribute.

Parameters:

categorySet - category set.

Throws:

InvalidArgumentException - is thrown - when categorySet is null

ODMException - is thrown - when setCategorySet is invoked for an attriubute whose AttributeType is not categorical.

Since:

10.1.0

getSparsitySpecification

public SparsitySpecification getSparsitySpecification()

Returns SparsitySpecification associated with an attribute.

Returns:

sparsity specification

Since:

10.1.0

setSparsitySpecification

public void setSparsitySpecification(SparsitySpecification sparsitySpec)

Sets SparsitySpecification associated with an attribute.

Parameters:

sparsitySpec - SparsitySpecification enum.

Since:

10.1.0