Main Page | Class Hierarchy | Class List | Class Members

kddml.Core.DataMining.MiningField Class Reference

Inheritance diagram for kddml.Core.DataMining.MiningField:

kddml.Core.DataMining.MiningFieldManager List of all members.

Public Member Functions

 MiningField (String name)
 MiningField (String name, byte usage)
boolean equals (MiningFieldManager mining_field)
String getName ()
byte getType ()
String toString ()

Detailed Description

A mining field is a single attribute used in MiningSchema. Each mining field is composed by a name and an usage type.
The name of a field is used as an identifier within the PMML document. When a application uses a PMML model it binds the actual parameter values to the input fields in the MiningSchema.
The usage type can be:
  1. active: field used as input (independent field).
  2. predicted: field whose value is predicted by the model.
  3. supplementary: field holding additional descriptive information. Supplementary fields are not required to apply a model. They are provided as additional information for explanatory purpose, though. When some field has gone through preprocessing transformations before a model is built, then an additional supplementary field is typically used to describe the statistics for the original field values.
  4. group: field similar to the SQL "group by". For example, this is used by the association and sequence models to group items into transactions by customerID or by transactionID.

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


Constructor & Destructor Documentation

kddml.Core.DataMining.MiningField.MiningField String  name  ) 
 

Constructor given the name of the field. Its type become active.

Parameters:
name String

kddml.Core.DataMining.MiningField.MiningField String  name,
byte  usage
 

Constructor given the name and the usage type.

Parameters:
name String
usage byte


Member Function Documentation

boolean kddml.Core.DataMining.MiningField.equals MiningFieldManager  mining_field  ) 
 

Returns true if two mining fields are equal. Two mining fields are equal if they have the same name.

Parameters:
mining_field MiningFieldManager
Returns:
boolean

Implements kddml.Core.DataMining.MiningFieldManager.

String kddml.Core.DataMining.MiningField.getName  ) 
 

Returns the name of the mining field.

Returns:
String

Implements kddml.Core.DataMining.MiningFieldManager.

byte kddml.Core.DataMining.MiningField.getType  ) 
 

Returns a number identifying the usage type of the mining field. Can be: active, predicted, supplementary, group.

Returns:
byte

Implements kddml.Core.DataMining.MiningFieldManager.

String kddml.Core.DataMining.MiningField.toString  ) 
 

Returns a representation of this object as string.

Returns:
String


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