org.licas_text.model

Class VSM

java.lang.Object

org.licas_text.model.VSM

public class VSM
extends java.lang.Object

This class represents a ArrayList Space Model that can be used to store analysis for different documents, to allow for comparisons across the different analyses.

Author:

Kieran Greer

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.ArrayList<java.lang.Object>	docAnalysis List of analyses for different documents.

Constructor Summary

Constructors

Constructor and Description
VSM() Create a new instance of VSM.

Method Summary

Modifier and Type	Method and Description
void	addAnalysis(java.lang.Object theAnalysis) Add a new analysis object to the model.
void	clearAnalyses() Clear the analysis list of all entries
java.util.ArrayList<java.lang.Object>	getAnalyses() Get the list of document analyses.
boolean	hasAnalyses() Return true if the list of analysis objects is not empty.

Methods inherited from class java.lang.Object

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

Field Detail

docAnalysis

protected java.util.ArrayList<java.lang.Object> docAnalysis

List of analyses for different documents. The analysis object itself can be of any type and so this list is nothing more than a standard ArrayList list of objects.

Constructor Detail

VSM

public VSM()

Create a new instance of VSM.

Method Detail

hasAnalyses

public boolean hasAnalyses()

Return true if the list of analysis objects is not empty.

Returns:

true if docAnalysis is not null and contains elements, false otherwise.

clearAnalyses

public void clearAnalyses()

Clear the analysis list of all entries

addAnalysis

public void addAnalysis(java.lang.Object theAnalysis)

Add a new analysis object to the model. This is always added.

Parameters:

theAnalysis - the object to add.

getAnalyses

public java.util.ArrayList<java.lang.Object> getAnalyses()

Get the list of document analyses.

Returns:

the value of docAnalysis.