Main Page | Class Hierarchy | Class List | Class Members

kddml.Operators.AlgorithmLoaderSettings Class Reference

Inheritance diagram for kddml.Operators.AlgorithmLoaderSettings:

kddml.Operators.OperatorSettings kddml.Operators.DataMining.DMAlgorithmLoaderSettings kddml.Operators.Preprocessing.PPAlgorithmLoaderSettings kddml.Operators.DataMining.CLUSTER_MINER_SETTINGS kddml.Operators.DataMining.RDA_MINER_SETTINGS kddml.Operators.DataMining.SEQUENCE_MINER_SETTINGS kddml.Operators.DataMining.TREE_MINER_SETTINGS kddml.Operators.Preprocessing.PP_NORMALIZATION_SETTINGS kddml.Operators.Preprocessing.PP_NUMERIC_DISCRETIZATION_SETTINGS kddml.Operators.Preprocessing.PP_REWRITING_SETTINGS kddml.Operators.Preprocessing.PP_SAMPLING_SETTINGS List of all members.

Public Member Functions

String[] listAttributes ()
Boolean isRequired (String attribute_name)
Boolean isFixed (String attribute_name)
String getDefaultAttributeValue (String attribute_name)
KDDMLScalarType getAttributeType (String attribute_name)
void checkAttributes (Hashtable< String, KDDMLScalarManager > attributes) throws SettingsException
Hashtable< String, KDDMLScalarManagerrefreshAttributes (Hashtable< String, KDDMLScalarManager > attributes)

Static Public Attributes

static final String ALG_NAME = "algorithm_name"

Detailed Description

An abstract class for operators that use a system algorithm (both preprocessing and mining) (e.g. RDA_MINER, PP_NORMALIZATION).

Title: KDDML

Description: Knowledge Discovery in Database Environment

Copyright: Copyright (c) 2003-2005

Company: Universita' di Pisa - Dipartimento di Informatica

Author:
Andrea Romei (romei@di.unipi.it)
Version:
2.0.16


Member Function Documentation

String [] kddml.Operators.AlgorithmLoaderSettings.listAttributes  )  [virtual]
 

Returns the list of attributes belonging to the operator specification.

Returns:
String[]

Implements kddml.Operators.OperatorSettings.

Reimplemented in kddml.Operators.DataMining.TREE_MINER_SETTINGS, kddml.Operators.Preprocessing.PP_NORMALIZATION_SETTINGS, kddml.Operators.Preprocessing.PP_NUMERIC_DISCRETIZATION_SETTINGS, and kddml.Operators.Preprocessing.PP_REWRITING_SETTINGS.

Boolean kddml.Operators.AlgorithmLoaderSettings.isRequired String  attribute_name  )  [virtual]
 

Returns true if a given attribute is required in the operator specification. Returns false if the attribute is implied or fixed. Finally, the method returns null if the attribute name do not belong to the list of attributes returned by the method listAttributes().

Parameters:
attribute_name String
Returns:
boolean

Implements kddml.Operators.OperatorSettings.

Reimplemented in kddml.Operators.DataMining.TREE_MINER_SETTINGS, kddml.Operators.Preprocessing.PP_NORMALIZATION_SETTINGS, kddml.Operators.Preprocessing.PP_NUMERIC_DISCRETIZATION_SETTINGS, and kddml.Operators.Preprocessing.PP_REWRITING_SETTINGS.

Boolean kddml.Operators.AlgorithmLoaderSettings.isFixed String  attribute_name  )  [virtual]
 

Returns true if a given attribute is fixed (i.e. constant) in the operator specification. Returns false if the attribute is implied or required. Finally, the method returns null if the attribute name do not belong to the list of attributes returned by the method listAttributes().

Parameters:
attribute_name String
Returns:
boolean

Implements kddml.Operators.OperatorSettings.

Reimplemented in kddml.Operators.DataMining.TREE_MINER_SETTINGS, kddml.Operators.Preprocessing.PP_NORMALIZATION_SETTINGS, kddml.Operators.Preprocessing.PP_NUMERIC_DISCRETIZATION_SETTINGS, and kddml.Operators.Preprocessing.PP_REWRITING_SETTINGS.

String kddml.Operators.AlgorithmLoaderSettings.getDefaultAttributeValue String  attribute_name  )  [virtual]
 

Returns the default value related to a given input attribute. Returns null if the attribute do not admit a default value. An attribute can be given any legal value as a default. The attribute value is not required on each element in the document, but if it is not present, it will appear to be the specified default. If the attribute is implied and it is not included in the element, the operator assumes that this is the attribute value.

Parameters:
attribute_name String
Returns:
String

Implements kddml.Operators.OperatorSettings.

Reimplemented in kddml.Operators.DataMining.TREE_MINER_SETTINGS, kddml.Operators.Preprocessing.PP_NORMALIZATION_SETTINGS, kddml.Operators.Preprocessing.PP_NUMERIC_DISCRETIZATION_SETTINGS, and kddml.Operators.Preprocessing.PP_REWRITING_SETTINGS.

KDDMLScalarType kddml.Operators.AlgorithmLoaderSettings.getAttributeType String  attribute_name  )  [virtual]
 

Returns the type related to a given input attribute. KDDML supports the attribute types as expressed by the class KDDMLScalarType. Returns null if the attribute name do no belong to the list of attributes returned by the method listAttributes().

Parameters:
attribute_name String
Returns:
KDDMLScalarType

Implements kddml.Operators.OperatorSettings.

Reimplemented in kddml.Operators.DataMining.TREE_MINER_SETTINGS, kddml.Operators.Preprocessing.PP_NORMALIZATION_SETTINGS, kddml.Operators.Preprocessing.PP_NUMERIC_DISCRETIZATION_SETTINGS, and kddml.Operators.Preprocessing.PP_REWRITING_SETTINGS.

void kddml.Operators.AlgorithmLoaderSettings.checkAttributes Hashtable< String, KDDMLScalarManager attributes  )  throws SettingsException
 

Overloading of super.checkAttributes(Hashtable attributes).
Performs a correctness control about the input attributes of the operator (e.g., check that the level attribute of the PP_HIERARCHY_DISCRETIZATION operator is a positive integer number. Attributes are given as hash-table where the key of the hashtable is the XML attribute name and the value of the hashtable is the XML attribute value as KDDMLScalarManager. The method throws an exception if an error is occurs. More precisely, for each attribute returned by listAttributes(), the method checks if the hashtable contains the attribute. If this is the case, then a type checking is performed on attribute value. Otherwise, if the attribute is required (i.e. the method isRequired() returns true), then the method throws an exception.

Parameters:
attributes Hashtable the input attributes with the name as key and the value as KDDMLScalarManager object.
Exceptions:
SettingsException if a type checking error occurs or the attribute is required but the hashtable do not contains it.

Reimplemented from kddml.Operators.OperatorSettings.

Reimplemented in kddml.Operators.Preprocessing.PP_REWRITING_SETTINGS.

Hashtable<String, KDDMLScalarManager> kddml.Operators.AlgorithmLoaderSettings.refreshAttributes Hashtable< String, KDDMLScalarManager attributes  ) 
 

Overloading of super.refreshAttributes(Hashtable attributes).
Sets the types and the default values of all attributes returned by the listAttributes() method. The type is obtained by means the method getAttributeType(attr_name) that takes the attribute name as input. If the attribute value is fixed (i.e. the method isFixed(attr_name) returns true), then its value is replaced with the default value in the hashtable. The default value is obtained by means the method getDefaultValue(attr_name) that takes the attribute name as input. Finally, if an optional attribute do not belong to the hashtable and a default value is provided for that attribute, then its value is added to the input hashtable. The method returns the new hashtable as output.

Parameters:
attributes Hashtable
Returns:
Hashtable

Reimplemented from kddml.Operators.OperatorSettings.


Member Data Documentation

final String kddml.Operators.AlgorithmLoaderSettings.ALG_NAME = "algorithm_name" [static]
 

The algorithm name XML attribute.


Generated on Thu Feb 23 13:04:46 2006 for kddml by  doxygen 1.4.3