Main Page | Class Hierarchy | Class List | Class Members

kddml.Core.DataMining.DataField Class Reference

Inheritance diagram for kddml.Core.DataMining.DataField:

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

Public Member Functions

 DataField (String name)
 DataField (String name, byte type)
void addEnumeratedValue (String value) throws MiningModelException
String[] getEnumeratedValues ()
boolean equals (DataFieldManager data_field)
void setDisplayedName (String display_name)
void setType (byte type)
String getName ()
String getDisplayedName ()
byte getType ()
String toString ()
String getStringType ()

Detailed Description

The field used in DataDictionary. The name of a data field must be unique in the data dictionary. The displayName is a string which may be used by applications to refer to that field. Within the XML document only the value of name is significant. If displayName is not given, then name is the default value.
Field type can be:
  1. categorical for discrete attributes;
  2. ordinal for string attributes;
  3. continuous for numeric attributes;

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.DataField.DataField String  name  ) 
 

Constructor give the field name. It constructs an ordinal attribute.

Parameters:
name String

kddml.Core.DataMining.DataField.DataField String  name,
byte  type
 

Constructor given the field name and the type.

Parameters:
name String
type byte


Member Function Documentation

void kddml.Core.DataMining.DataField.addEnumeratedValue String  value  )  throws MiningModelException
 

Adds a new category to a discrete field. Throws an exception if the field is not discrete.

Parameters:
value String
Exceptions:
MiningModelException 

Implements kddml.Core.DataMining.DataFieldManager.

String [] kddml.Core.DataMining.DataField.getEnumeratedValues  ) 
 

Returns enumerated values for a nominal attribute as array of strings. Return an empty array if the attribute is not discrete.

Returns:
String[]

Implements kddml.Core.DataMining.DataFieldManager.

boolean kddml.Core.DataMining.DataField.equals DataFieldManager  data_field  ) 
 

Compares two data fields. Returns true two data fields are equal.

Parameters:
data_field DataFieldManager
Returns:
boolean

Implements kddml.Core.DataMining.DataFieldManager.

void kddml.Core.DataMining.DataField.setDisplayedName String  display_name  ) 
 

Sets the displayed name of the field.

Parameters:
display_name String

Implements kddml.Core.DataMining.DataFieldManager.

void kddml.Core.DataMining.DataField.setType byte  type  ) 
 

Sets the type of the field.

Parameters:
type byte

Implements kddml.Core.DataMining.DataFieldManager.

String kddml.Core.DataMining.DataField.getName  ) 
 

Returns the name of the data field.

Returns:
String

Implements kddml.Core.DataMining.DataFieldManager.

String kddml.Core.DataMining.DataField.getDisplayedName  ) 
 

Return the displayed name of the field.

Returns:
String

Implements kddml.Core.DataMining.DataFieldManager.

byte kddml.Core.DataMining.DataField.getType  ) 
 

Return the type of the field. Can be categorical, ordinal, continuous. Categorical fields have the operator "=", ordinal fields have an additional "<", and continuous fields also have arithmetic operators.

Returns:
byte

Implements kddml.Core.DataMining.DataFieldManager.

String kddml.Core.DataMining.DataField.toString  ) 
 

Returns a representation of this object as string.

Returns:
String

String kddml.Core.DataMining.DataField.getStringType  ) 
 

Returns a string representation of the type.

Returns:
String

Implements kddml.Core.DataMining.DataFieldManager.


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