idl.tmt.representation.transformations
Interface CollectionTransformation

All Known Implementing Classes:

MatrixRowNormalizer, StopListFilter, TermOccurrenceFilter, BinarizeAllTermsTransformation, TfIdfWeighter, MatrixColumnCenterer

public interface CollectionTransformation

Generic interface to support transformations on an indexed collection. includes transformations to matrices, termlists, and document maps.

Author:

miles, jelsas

Field Summary

static java.lang.String	STATUS_COMPLETE
static java.lang.String	STATUS_NONE

Method Summary

java.lang.String	getStatus() Provides a short string description of the collection transformation.
boolean	makesMatrixDense() Indicates whether the modification to the collection by this transformation makes the underlying matrix a dense matrix.
void	transformCollection(IndexedCollection collection) general method for transforming the given collection.

Field Detail

STATUS_NONE

public static final java.lang.String STATUS_NONE

STATUS_COMPLETE

public static final java.lang.String STATUS_COMPLETE

Method Detail

transformCollection

public void transformCollection(IndexedCollection collection)

general method for transforming the given collection. the implementors should modify this colleciton object, not create a new one.

Parameters:

collection -

makesMatrixDense

public boolean makesMatrixDense()

Indicates whether the modification to the collection by this transformation makes the underlying matrix a dense matrix. This method is used to indicated if the matrix should be written to disk after this transformation is performed.

Returns:

getStatus

public java.lang.String getStatus()

Provides a short string description of the collection transformation. Implementors should return the CollectionTransformation.STAUS_NONE if the transformation has not yet been run.