com.sun.labs.minion.classification
Class ExtraClassification

java.lang.Object
  extended by com.sun.labs.minion.classification.ExtraClassification
All Implemented Interfaces:
com.sun.labs.util.props.Component, com.sun.labs.util.props.Configurable

public class ExtraClassification
extends java.lang.Object
implements com.sun.labs.util.props.Configurable

A configurable container that can be used to describe a set of classification operations to perform that would not be done by the standard classification approach. In particular, this class can be used to apply classifiers that were built from the contents of one vectored field against the contents of a different vectored field.

Normally, classifiers are only applied against the vectored fields from which they were built, but there may be cases where this behavior needs to be overridden. By providing a list of instances of this class to the ClassifierManager.PROP_EXTRA_CLASSIFICATIONS property. A set of non-standard classification operations can be performed.

See Also:
ClassifierManager.PROP_EXTRA_CLASSIFICATIONS

Field Summary
static java.lang.String PROP_CLASSIFIER_FROM_FIELD
           
static java.lang.String PROP_CLASSIFIER_RESULT_FIELDS
           
static java.lang.String PROP_DOCUMENT_FROM_FIELDS
           
static java.lang.String PROP_EXCLUDED_CLASSIFIERS
          A configurable list of classifier names to exclude when doing this extra classification.
 
Constructor Summary
ExtraClassification()
           
 
Method Summary
 java.lang.String getClassifierFromField()
           
 java.util.List<java.lang.String> getClassifierResultFields()
           
 java.util.List<java.lang.String> getDocumentFromFields()
           
 boolean isExcluded(java.lang.String name)
           
 void newProperties(com.sun.labs.util.props.PropertySheet ps)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROP_CLASSIFIER_FROM_FIELD

@ConfigString
public static final java.lang.String PROP_CLASSIFIER_FROM_FIELD
See Also:
Constant Field Values

PROP_DOCUMENT_FROM_FIELDS

@ConfigComponentList(type=FieldInfo.class)
public static final java.lang.String PROP_DOCUMENT_FROM_FIELDS
See Also:
Constant Field Values

PROP_CLASSIFIER_RESULT_FIELDS

@ConfigComponentList(type=FieldInfo.class,
                     defaultList={})
public static final java.lang.String PROP_CLASSIFIER_RESULT_FIELDS
See Also:
Constant Field Values

PROP_EXCLUDED_CLASSIFIERS

@ConfigStringList(defaultList={})
public static final java.lang.String PROP_EXCLUDED_CLASSIFIERS
A configurable list of classifier names to exclude when doing this extra classification.

See Also:
Constant Field Values
Constructor Detail

ExtraClassification

public ExtraClassification()
Method Detail

getClassifierFromField

public java.lang.String getClassifierFromField()

getDocumentFromFields

public java.util.List<java.lang.String> getDocumentFromFields()

getClassifierResultFields

public java.util.List<java.lang.String> getClassifierResultFields()

isExcluded

public boolean isExcluded(java.lang.String name)

newProperties

public void newProperties(com.sun.labs.util.props.PropertySheet ps)
                   throws com.sun.labs.util.props.PropertyException
Specified by:
newProperties in interface com.sun.labs.util.props.Configurable
Throws:
com.sun.labs.util.props.PropertyException