IFrequencyAccessAdapter< T extends IFrequencies > Interface Reference

Inheritance diagram for IFrequencyAccessAdapter< T extends IFrequencies >:

Collaboration diagram for IFrequencyAccessAdapter< T extends IFrequencies >:

List of all members.

---

Detailed Description

An IAccessAdapter for IFrequencies.

Author:

sschwieb

Classes
class	AdapterTest
Public Methods
int	getNumberOfDocuments ()
IFrequencies	getFrequenciesOf (@SignalId String documentId)
int	getNumberOfAnnotations (@SignalId String documentId)
int	getOverallNumberOfAnnotations ()
int	getNumberOfOccurrencesOfType (long typeId,@SignalId String documentId)
int	getOverallNumberOfOccurrencesOfType (long typeId)
Iterator< Long >	getTypesOfDocument (@SignalId String documentId)
Iterator< Long >	getAllTypes ()
int	getOverallNumberOfTypes ()
Iterator< Long >	getMostFrequentTypes (int maxResultListSize)
Iterator< Long >	getLeastFrequentTypes (int maxResultListSize)

---

Method Details

Iterator<Long> getAllTypes

(

)

IFrequencies getFrequenciesOf

(

@SignalId String

documentId

)

Returns the IFrequencies object of the given document. If documentId is null, an IFrequencies object for all processed signals is returned.

Parameters:

documentId

Returns:

Iterator<Long> getLeastFrequentTypes

(

int

maxResultListSize

)

Returns an iterator of least frequent types found in the processed document collection. The size of the list is limited by the parameter maxResultListSize, which must be a value > 0. The returned values are sorted ascending by their frequency.

Parameters:

maxResultListSize

Returns:

Iterator<Long> getMostFrequentTypes

(

int

maxResultListSize

)

Returns an iterator of most frequent types found in the processed document collection. The size of the list is limited by the parameter maxResultListSize, which must be a value > 0. The returned values are sorted descending by their frequency.

Parameters:

maxResultListSize

Returns:

int getNumberOfAnnotations

(

@SignalId String

documentId

)

Returns the number of annotations in the given document.

Parameters:

documentId

Returns:

int getNumberOfDocuments

(

)

Returns the overall number of documents.

Returns:

int getNumberOfOccurrencesOfType	(	long	typeId,
		@SignalId String	documentId
	)

Returns the number of occurrences of the given type in the given document.

Parameters:

typeId
documentId

Returns:

int getOverallNumberOfAnnotations

(

)

Returns the overall number of annotations.

Returns:

int getOverallNumberOfOccurrencesOfType

(

long

typeId

)

Returns the overall number of occurrences of the given type in the processed document collection.

Parameters:

typeId

Returns:

int getOverallNumberOfTypes

(

)

Returns the overall number of different types in the processed document collection.

Returns:

Iterator<Long> getTypesOfDocument

(

@SignalId String

documentId

)

Returns an iterator over the list of all types in the document.

Parameters:

documentId

Returns: