javax.datamining.data
Interface LogicalData

All Superinterfaces:

MiningObject

public interface LogicalData

extends MiningObject

LogicalData instance is a set of logical attributes that describe the logical nature of the data used as input for model building. The mining attributes each have unique names within a LogicalData instance.

Author:

JSR-73 Java Data Mining Expert Group

See Also:

MiningObject

Method Summary

void	addAttribute(LogicalAttribute attribute) Adds the specified LogicalAttribute instance to the logical data.
LogicalAttribute	getAttribute(java.lang.String name) Returns the named logical attribute present in the logical data.
java.util.Collection	getAttributes() Returns a collection of logical attributes present in the logical data.
java.util.Collection	getAttributes(AttributeType type) Returns a collection of logical attributes of the specified attribute type present in the logical data.
void	removeAllAttributes() Removes all logical attributes from the LogicalData instance.
void	removeAttribute(java.lang.String attributeName) Removes the specified LogicalAttribute instance from the logical data.

Methods inherited from interface javax.datamining.MiningObject

getCreationDate, getCreatorInfo, getDescription, getName, getObjectIdentifier, getObjectType, setDescription

Method Detail

addAttribute

public void addAttribute(LogicalAttribute attribute)
                  throws JDMException

Adds the specified LogicalAttribute instance to the logical data. If the name of the attribute is not unique within the set already present in the logical data, an exception is thrown.

Parameters:

attribute - A logical attribute to be added.

Returns:

void

Throws:

JDMException

getAttribute

public LogicalAttribute getAttribute(java.lang.String name)
                              throws JDMException

Returns the named logical attribute present in the logical data.

Parameters:

name - The name of the logical attribute to be returned.

Returns:

LogicalAttribute

Throws:

JDMException

getAttributes

public java.util.Collection getAttributes()

Returns a collection of logical attributes present in the logical data.

Returns:

Collection

getAttributes

public java.util.Collection getAttributes(AttributeType type)
                                   throws JDMException

Returns a collection of logical attributes of the specified attribute type present in the logical data.

Parameters:

type - The type of the logical attributes to be returned.

Returns:

Collection

Throws:

JDMException

removeAllAttributes

public void removeAllAttributes()

Removes all logical attributes from the LogicalData instance.

Returns:

void

removeAttribute

public void removeAttribute(java.lang.String attributeName)
                     throws JDMException

Removes the specified LogicalAttribute instance from the logical data. If the name of the attribute is not found within the set present in the logical data, an exception is thrown.

Parameters:

attributeName - The name of the logical attribute to be removed.

Returns:

void

Throws:

JDMException