Main Page | Class Hierarchy | Class List | Class Members

kddml.Operators.Preprocessing.RewritingAlgorithms.RULE_S_REWRITING_SETTINGS Class Reference

List of all members.

Public Member Functions

String[] listParameters ()
Boolean isRequiredParameter (String param_name)
Boolean isFixedParameter (String param_name)
String getDefaultParameterValue (String param_name)
KDDMLScalarType getParameterType (String param_name)
void checkCorrelationBetweenParameters (Hashtable< String, KDDMLScalarManager > parameters) throws SettingsException

Detailed Description

The rule-S method replaces the entire input string value that matches the pattern with a given replacement string that may contain references to captured sub-sequences (see later). Notice that, the matching procedure is performed on the entire input string value, i.e., the algorithm tries to match the entire input sequence against the pattern. For example, the regular expression "dog" match a sub-sequence of the pattern "dogcatdog", but not the entire string. In this example, the matching procedure returns failure.
The user must specify two replacement strings by using two different algorithm parameters.
The first one, called substitution then, is applied to the entire string value if the pattern matches that string; the second one, called substitution else, is applied to the string value only if the pattern does not match. The substitution else parameter is optional. For example, given the regular expression "a*b", the "then" replacement string "ok" and the "else" replacement string "ko", an invocation of this method on the instance value "aaaaab" would yield the string "ok". Otherwise, an invocation on the instance value "aaaaabb" would yield the string "ko". If no substitution is performed, then the instance value is marked (i.e. a string is added to preprocessing information) with an exception for the rewriting attribute. Anyhow, the marking policy is optional.
Parameters:

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)

Sandra Zimei

Version:
2.0.16


Member Function Documentation

String [] kddml.Operators.Preprocessing.RewritingAlgorithms.RULE_S_REWRITING_SETTINGS.listParameters  ) 
 

Returns the list of parameters belonging to the algorithm specification.

Returns:
String[]

Boolean kddml.Operators.Preprocessing.RewritingAlgorithms.RULE_S_REWRITING_SETTINGS.isRequiredParameter String  param_name  ) 
 

Returns true if a given parameter is required in the algorithm specification. Returns false if the parameter is implied or fixed. Finally, the method returns null if the parameter name do not belong to the list of parameters returned by the method listParameters().

Parameters:
param_name String
Returns:
Boolean

Boolean kddml.Operators.Preprocessing.RewritingAlgorithms.RULE_S_REWRITING_SETTINGS.isFixedParameter String  param_name  ) 
 

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

Parameters:
param_name String
Returns:
Boolean

String kddml.Operators.Preprocessing.RewritingAlgorithms.RULE_S_REWRITING_SETTINGS.getDefaultParameterValue String  param_name  ) 
 

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

Parameters:
param_name String
Returns:
String

KDDMLScalarType kddml.Operators.Preprocessing.RewritingAlgorithms.RULE_S_REWRITING_SETTINGS.getParameterType String  param_name  ) 
 

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

Parameters:
param_name String
Returns:
KDDMLScalarType

void kddml.Operators.Preprocessing.RewritingAlgorithms.RULE_S_REWRITING_SETTINGS.checkCorrelationBetweenParameters Hashtable< String, KDDMLScalarManager parameters  )  throws SettingsException
 

Checks the correctness correlation between algorithm parameters. This method depends on the correlation level between the parameters and it is empty for a specific algorithm if and only if all parameter are independent. As instance, the minimum support and the minimum confidence in the APRIORI algorithm are independent. However, the value of the percentage splitting for a classification algorithm depends on the classification strategy adopted and must be required only if the algorithm uses a splitting technique. The method can incorporate further controls independent on input parameters, e.g. that some particular events are true when the algorithm is applied.

Parameters:
parameters Hashtable the paramters related to the operator with the relative value. The key of the hashtable is the name of the attribute. The value of the hashtable is a KDDMLScalar representing the value of the attribute. Each single attribute value is correct.
Exceptions:
SettingsException if the correlation checking returns an error.


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