dragon.ir.clustering
Class AbstractClustering

java.lang.Object
  |
  +--dragon.ir.clustering.AbstractClustering

All Implemented Interfaces:

Clustering

Direct Known Subclasses:

BasicKMean, BisectKMean, HierClustering, LinkKMean

public abstract class AbstractClustering

extends java.lang.Object

implements Clustering

Abstract class for document clustering

Description:

Copyright: Copyright (c) 2005

Company: IST, Drexel University

Version:

1.0

Author:

Davis Zhou

Field Summary

protected int	clusterNum
protected DocClusterSet	clusterSet
protected FeatureFilter	featureFilter
protected IndexReader	indexReader
protected long	randomSeed
protected boolean	showProgress

Constructor Summary

AbstractClustering(IndexReader indexReader)

Method Summary

boolean	cluster() Cluster all documents in the index reader to the given number of clusters
DocCluster	getCluster(int index) One should call the cluster method before calling this method.
int	getClusterNum()
DocClusterSet	getClusterSet() One should call the cluster method before calling this method.
FeatureFilter	getFeatureFilter()
IndexReader	getIndexReader()
long	getRandomSeed()
void	setFeatureFilter(FeatureFilter selector)
void	setRandomSeed(long seed)
void	setShowProgress(boolean option)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface dragon.ir.clustering.Clustering

cluster

Field Detail

indexReader

protected IndexReader indexReader

featureFilter

protected FeatureFilter featureFilter

clusterNum

protected int clusterNum

clusterSet

protected DocClusterSet clusterSet

showProgress

protected boolean showProgress

randomSeed

protected long randomSeed

Constructor Detail

AbstractClustering

public AbstractClustering(IndexReader indexReader)

Method Detail

getClusterNum

public int getClusterNum()

Specified by:

getClusterNum in interface Clustering

Returns:

the number of clusters

getRandomSeed

public long getRandomSeed()

Specified by:

getRandomSeed in interface Clustering

setRandomSeed

public void setRandomSeed(long seed)

Specified by:

setRandomSeed in interface Clustering

getClusterSet

public DocClusterSet getClusterSet()

Description copied from interface: Clustering

One should call the cluster method before calling this method.

Specified by:

getClusterSet in interface Clustering

Returns:

all clusters

getCluster

public DocCluster getCluster(int index)

Description copied from interface: Clustering

One should call the cluster method before calling this method.

Specified by:

getCluster in interface Clustering

Parameters:

index - the index of the cluster of interest

Returns:

the given cluster

getIndexReader

public IndexReader getIndexReader()

Specified by:

getIndexReader in interface Clustering

Returns:

the index reader the clustering method is working on

cluster

public boolean cluster()

Description copied from interface: Clustering

Cluster all documents in the index reader to the given number of clusters

Specified by:

cluster in interface Clustering

Returns:

true if clustering successfully

getFeatureFilter

public FeatureFilter getFeatureFilter()

Specified by:

getFeatureFilter in interface Clustering

setFeatureFilter

public void setFeatureFilter(FeatureFilter selector)

Specified by:

setFeatureFilter in interface Clustering

setShowProgress

public void setShowProgress(boolean option)