Package com.groiss.ml.field

Interface Field

All Known Implementing Classes:
ProcessField
public interface Field
Specifies the data source for an Attribute. Such a source is used to retrieve the value for an attribute or to store that value (but only if isAllowedAsOutputField() returns true for the field instance).

  • Method Summary

    Modifier and Type
    Method
    Description
    <T> Attribute<T>
    getAttribute()
    An Attribute object which represents this field in a given context (e.g. when nominal there must exist some values)
    String
    getFieldName()
    Returns the name of the field of the data source.
    String
    getFieldNamePretty()
    A human readable string representing the name of the field of the data source
    default String
    getFullFieldName()
    A string of form fieldname|source
    String
    getSource()
    Returns the name of the class of the data source.
    String
    getSourcePretty()
    A human readable string representing the class of the data source
    default boolean
    isAllowedAsOutputField()
    Returns true if this field is allowed as output within in a given context

  • Method Details

    • getFieldName

      String getFieldName()
      Returns the name of the field of the data source.
      Returns:
      the field which is to consider

    • getFieldNamePretty

      String getFieldNamePretty()
      A human readable string representing the name of the field of the data source
      Returns:
      a String representing the field name as it should be displayed

    • getSource

      String getSource()
      Returns the name of the class of the data source.
      Returns:
      a class name which indicates where to assign the field to

    • getSourcePretty

      String getSourcePretty()
      A human readable string representing the class of the data source
      Returns:
      a String representing the source as it should be displayed

    • getAttribute

      <T> Attribute<T> getAttribute()
      An Attribute object which represents this field in a given context (e.g. when nominal there must exist some values)
      Returns:
      the Attribute

    • getFullFieldName

      default String getFullFieldName()
      A string of form fieldname|source
      Returns:
      a string of form fieldname|source

    • isAllowedAsOutputField

      default boolean isAllowedAsOutputField()
      Returns true if this field is allowed as output within in a given context
      Returns:
      true is usable as output field