: Class IndexingModalities

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

gov.nist.nlpir.irf.modality
Class IndexingModalities

java.lang.Object
  |
  +--gov.nist.nlpir.irf.modality.IndexingModalities

public class IndexingModalities
extends java.lang.Object
implements java.io.Serializable

A collection of Indexing Modality Units

Version:: $Revision: 1.2 $
Author:: This software was produced by NIST, an agency of the U.S. government, and by statute is not subject to copyright in the United States. Recipients of this software assume all responsibilities associated with its operation, modification and maintenance.
See Also:: IndexingModalityUnit, Document, Serialized Form

Field Summary
`private java.util.Vector`	`modalitylist` Vector of IndexingModalityUnits
`(package private) static long`	`serialVersionUID` serial version universal id - put here so Java does not insert one which may change due to revisions and make it impossible to deserialize earlier versions of serialized objects

Constructor Summary
`IndexingModalities()` Constructs a new modalities container

Method Summary
`void`	`addModality(IndexingModalityUnit imu)` Adds a modality
`java.util.Vector`	`getModalities()` Returns vector of indexing modality units.
`IndexingModalityUnit`	`getModalityAt(int index)` Gets modality unit at a given index (0-based)
`int`	`getModalityCount()` Gets the count of modalities
`void`	`present()` Displays indexing modalities
`void`	`removeModalityAt(int index)` Removes modality unit at given index (0-based)
`void`	`save()` Saves each IMU
`boolean`	`validate(DocumentIntrf r)` Validates settings w.r.t.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

static final long serialVersionUID

serial version universal id - put here so Java does not insert one which may change due to revisions and make it impossible to deserialize earlier versions of serialized objects

modalitylist

private java.util.Vector modalitylist

Vector of IndexingModalityUnits

Constructor Detail

IndexingModalities

public IndexingModalities()

Constructs a new modalities container

Method Detail

addModality

public final void addModality(IndexingModalityUnit imu)

Adds a modality

Parameters:: imu - indexing modality unit

getModalityCount

public final int getModalityCount()

Gets the count of modalities

Returns:: count of modalities

getModalityAt

public final IndexingModalityUnit getModalityAt(int index)

Gets modality unit at a given index (0-based)

Parameters:: index - index of IMU to return
Returns:: n-th modality

removeModalityAt

public final void removeModalityAt(int index)

Removes modality unit at given index (0-based)

Parameters:: index - index of IMU to remove

getModalities

public final java.util.Vector getModalities()

Returns vector of indexing modality units.

Returns:: collection of indexing modalities as a vector.

present

public void present()

Displays indexing modalities

validate

public boolean validate(DocumentIntrf r)

Validates settings w.r.t. a Doc

Parameters:: r - document to validate against
Returns:: true if valid, false otherwise.

save

public void save()

Saves each IMU