Index (Okapi TM Pensieve 0.35 API)

C D E F G H I M N O P S T U V

C

close() - Method in interface net.sf.okapi.tm.pensieve.seeker.ITmSeeker: Close the searcher
close() - Method in class net.sf.okapi.tm.pensieve.seeker.PensieveSeeker
close() - Method in interface net.sf.okapi.tm.pensieve.writer.ITmWriter: Closes the index and forces a commit against the index.
close() - Method in class net.sf.okapi.tm.pensieve.writer.PensieveWriter: Commits and closes (for now) the transaction.
commit() - Method in interface net.sf.okapi.tm.pensieve.writer.ITmWriter: Forces a commit against the index.
commit() - Method in class net.sf.okapi.tm.pensieve.writer.PensieveWriter: Forces a commit against the index.
compareTo(TmHit) - Method in class net.sf.okapi.tm.pensieve.common.TmHit: This method implements a three way sort on (1) MatchType (2) score (3) source string.
convertToTextUnit(TranslationUnit) - Static method in class net.sf.okapi.tm.pensieve.common.PensieveUtil: Converts a TranslationUnit to a TextUnit
convertToTranslationUnit(LocaleId, LocaleId, ITextUnit) - Static method in class net.sf.okapi.tm.pensieve.common.PensieveUtil: Converts an un-segmented TextUnit into a TranslationUnit.
createFileBasedTmSeeker(String) - Static method in class net.sf.okapi.tm.pensieve.seeker.TmSeekerFactory
createFileBasedTmWriter(String, boolean) - Static method in class net.sf.okapi.tm.pensieve.writer.TmWriterFactory
createIndexSearcher() - Method in class net.sf.okapi.tm.pensieve.seeker.PensieveSeeker

D

delete(String) - Method in interface net.sf.okapi.tm.pensieve.writer.ITmWriter: Deletes a TranslationUnit based on the id.
delete(String) - Method in class net.sf.okapi.tm.pensieve.writer.PensieveWriter: Deletes a TranslationUnit based on the id.

E

equals(Object) - Method in class net.sf.okapi.tm.pensieve.common.TmHit: Define equality of state.
exportTmx(LocaleId, LocaleId, ITmSeeker, TMXWriter) - Method in interface net.sf.okapi.tm.pensieve.tmx.ITmxExporter: Exports all Pensieve contents matching source and target language to TMX
exportTmx(LocaleId, ITmSeeker, TMXWriter) - Method in interface net.sf.okapi.tm.pensieve.tmx.ITmxExporter: Exports all Pensieve contents matching source languages to TMX
exportTmx(LocaleId, ITmSeeker, TMXWriter) - Method in class net.sf.okapi.tm.pensieve.tmx.OkapiTmxExporter: Exports all target locales in Pensieve to TMX
exportTmx(LocaleId, LocaleId, ITmSeeker, TMXWriter) - Method in class net.sf.okapi.tm.pensieve.tmx.OkapiTmxExporter: Exports only a specific target locale Pensieve to TMX

F

fieldName() - Method in enum net.sf.okapi.tm.pensieve.common.MetadataType
findMetadataType(String) - Static method in enum net.sf.okapi.tm.pensieve.common.MetadataType

G

getContent() - Method in class net.sf.okapi.tm.pensieve.common.TranslationUnitVariant
getDocId() - Method in class net.sf.okapi.tm.pensieve.common.TmHit: Get the document id for the TmHit.
getIndexDir() - Method in class net.sf.okapi.tm.pensieve.seeker.PensieveSeeker: Get the current Lucene Directory
getIndexSearcher() - Method in class net.sf.okapi.tm.pensieve.seeker.PensieveSeeker
getIndexWriter() - Method in class net.sf.okapi.tm.pensieve.writer.PensieveWriter: Gets a handle on the IndexWriter so that commits and rollbacks can happen outside.
getLanguage() - Method in class net.sf.okapi.tm.pensieve.common.TranslationUnitVariant
getMatchType() - Method in class net.sf.okapi.tm.pensieve.common.TmHit: Get the Tmhit's MatchType
getMetadata() - Method in class net.sf.okapi.tm.pensieve.common.TranslationUnit: Gets the metadata or attributes for this TU
getMetadataValue(MetadataType) - Method in class net.sf.okapi.tm.pensieve.common.TranslationUnit: Gets the value for a give metadata value field
getScore() - Method in class net.sf.okapi.tm.pensieve.common.TmHit: Get the TmHit's score.
getSource() - Method in class net.sf.okapi.tm.pensieve.common.TranslationUnit
getTarget() - Method in class net.sf.okapi.tm.pensieve.common.TranslationUnit
getTu() - Method in class net.sf.okapi.tm.pensieve.common.TmHit: Get the TmHit's TranslationUnit

H

hashCode() - Method in class net.sf.okapi.tm.pensieve.common.TmHit: A class that overrides equals must also override hashCode.

I

importTmx(URI, LocaleId, ITmWriter) - Method in interface net.sf.okapi.tm.pensieve.tmx.ITmxImporter: Imports TMX to Pensieve
importTmx(URI, LocaleId, ITmWriter) - Method in class net.sf.okapi.tm.pensieve.tmx.OkapiTmxImporter: Imports TMX to Pensieve
indexTranslationUnit(TranslationUnit) - Method in interface net.sf.okapi.tm.pensieve.writer.ITmWriter: Indexes a given translation unit.
indexTranslationUnit(TranslationUnit, boolean) - Method in interface net.sf.okapi.tm.pensieve.writer.ITmWriter: Indexes a given translation unit, possibly overwriting an existing one with the same source.
indexTranslationUnit(TranslationUnit) - Method in class net.sf.okapi.tm.pensieve.writer.PensieveWriter: Adds a TranslationUnit to the index
indexTranslationUnit(TranslationUnit, boolean) - Method in class net.sf.okapi.tm.pensieve.writer.PensieveWriter
indexType() - Method in enum net.sf.okapi.tm.pensieve.common.MetadataType
isCodeMismatch() - Method in class net.sf.okapi.tm.pensieve.common.TmHit: Is there a difference between the Codes of the TmHit and the query TextFragment?
isSourceEmpty() - Method in class net.sf.okapi.tm.pensieve.common.TranslationUnit: Checks to see if the the source is empty
isTargetEmpty() - Method in class net.sf.okapi.tm.pensieve.common.TranslationUnit: Checks to see if the the target is empty
iterator() - Method in class net.sf.okapi.tm.pensieve.seeker.PensieveSeeker: gets an iterator to traverse all translation units in the indexdir
ITmSeeker - Interface in net.sf.okapi.tm.pensieve.seeker: Used to query the TM.
ITmWriter - Interface in net.sf.okapi.tm.pensieve.writer
ITmxExporter - Interface in net.sf.okapi.tm.pensieve.tmx: The TMX interface to Pensieve.
ITmxImporter - Interface in net.sf.okapi.tm.pensieve.tmx

M

Metadata - Class in net.sf.okapi.tm.pensieve.common: A class that keeps track of the metadata of a TU
Metadata() - Constructor for class net.sf.okapi.tm.pensieve.common.Metadata
MetadataType - Enum in net.sf.okapi.tm.pensieve.common: The types of metadata that is supported.

N

net.sf.okapi.tm.pensieve.common - package net.sf.okapi.tm.pensieve.common
net.sf.okapi.tm.pensieve.seeker - package net.sf.okapi.tm.pensieve.seeker
net.sf.okapi.tm.pensieve.tmx - package net.sf.okapi.tm.pensieve.tmx
net.sf.okapi.tm.pensieve.writer - package net.sf.okapi.tm.pensieve.writer

O

OkapiTmxExporter - Class in net.sf.okapi.tm.pensieve.tmx: Used to interact with the Okapi Standards for TMX.
OkapiTmxExporter() - Constructor for class net.sf.okapi.tm.pensieve.tmx.OkapiTmxExporter
OkapiTmxImporter - Class in net.sf.okapi.tm.pensieve.tmx
OkapiTmxImporter(LocaleId, IFilter) - Constructor for class net.sf.okapi.tm.pensieve.tmx.OkapiTmxImporter: Creates an instance of OkapiTMXHandler
openIndexReader() - Method in class net.sf.okapi.tm.pensieve.seeker.PensieveSeeker

P

PensieveSeeker - Class in net.sf.okapi.tm.pensieve.seeker: Used to query the TM
PensieveSeeker(Directory) - Constructor for class net.sf.okapi.tm.pensieve.seeker.PensieveSeeker: Creates an instance of TMSeeker
PensieveSeeker(IndexWriter) - Constructor for class net.sf.okapi.tm.pensieve.seeker.PensieveSeeker: Creates an instance of TMSeeker.
PensieveUtil - Class in net.sf.okapi.tm.pensieve.common: A helper class
PensieveWriter - Class in net.sf.okapi.tm.pensieve.writer: Used to write, delete and update the index.
PensieveWriter(Directory, boolean) - Constructor for class net.sf.okapi.tm.pensieve.writer.PensieveWriter: Creates a PensieveWriter

S

searchExact(TextFragment, Metadata) - Method in interface net.sf.okapi.tm.pensieve.seeker.ITmSeeker: Get a list of exact matches for a given text fragment, taking inline codes in account.
searchExact(TextFragment, Metadata) - Method in class net.sf.okapi.tm.pensieve.seeker.PensieveSeeker
searchFuzzy(TextFragment, int, int, Metadata) - Method in interface net.sf.okapi.tm.pensieve.seeker.ITmSeeker: Get a list of fuzzy matches for a given text fragment, taking inline codes in account.
searchFuzzy(TextFragment, int, int, Metadata) - Method in class net.sf.okapi.tm.pensieve.seeker.PensieveSeeker: Search for exact and fuzzy matches
searchSimpleConcordance(String, int, int, Metadata) - Method in interface net.sf.okapi.tm.pensieve.seeker.ITmSeeker: Get a list of concordance matches (without position offsets) for a given text string.
searchSimpleConcordance(String, int, int, Metadata) - Method in class net.sf.okapi.tm.pensieve.seeker.PensieveSeeker
setCodeMismatch(boolean) - Method in class net.sf.okapi.tm.pensieve.common.TmHit: Set true of the Codes between the TmHit and query TextFragment are different.
setContent(TextFragment) - Method in class net.sf.okapi.tm.pensieve.common.TranslationUnitVariant
setDocId(int) - Method in class net.sf.okapi.tm.pensieve.common.TmHit: Set the document id for the TmHit.
setLocale(LocaleId) - Method in class net.sf.okapi.tm.pensieve.common.TranslationUnitVariant
setMatchType(MatchType) - Method in class net.sf.okapi.tm.pensieve.common.TmHit: Set the Tmhit's MatchType
setMetadata(Metadata) - Method in class net.sf.okapi.tm.pensieve.common.TranslationUnit
setMetadataValue(MetadataType, String) - Method in class net.sf.okapi.tm.pensieve.common.TranslationUnit: Sets the value for a give metadata value field
setScore(Float) - Method in class net.sf.okapi.tm.pensieve.common.TmHit: Set the TmHit's score.
setSource(TranslationUnitVariant) - Method in class net.sf.okapi.tm.pensieve.common.TranslationUnit
setTarget(TranslationUnitVariant) - Method in class net.sf.okapi.tm.pensieve.common.TranslationUnit
setTu(TranslationUnit) - Method in class net.sf.okapi.tm.pensieve.common.TmHit: Set the TmHit's TranslationUnit
store() - Method in enum net.sf.okapi.tm.pensieve.common.MetadataType

T

TmHit - Class in net.sf.okapi.tm.pensieve.common: Represents a TM Hit.
TmHit() - Constructor for class net.sf.okapi.tm.pensieve.common.TmHit: Default constructor which sets the MatchType to NONE.
TmHit(TranslationUnit, MatchType, float) - Constructor for class net.sf.okapi.tm.pensieve.common.TmHit: Create a new TmHit.
TmSeekerFactory - Class in net.sf.okapi.tm.pensieve.seeker
TmWriterFactory - Class in net.sf.okapi.tm.pensieve.writer
TmWriterFactory() - Constructor for class net.sf.okapi.tm.pensieve.writer.TmWriterFactory
toString() - Method in class net.sf.okapi.tm.pensieve.common.TranslationUnit
TranslationUnit - Class in net.sf.okapi.tm.pensieve.common: Represents a Unit of Translation.
TranslationUnit() - Constructor for class net.sf.okapi.tm.pensieve.common.TranslationUnit: Creates a TU w/o an source or target defined
TranslationUnit(TranslationUnitVariant, TranslationUnitVariant) - Constructor for class net.sf.okapi.tm.pensieve.common.TranslationUnit: Creates a TU with the provided source and targets
TranslationUnitField - Enum in net.sf.okapi.tm.pensieve.common: A field of a translation unit.
TranslationUnitVariant - Class in net.sf.okapi.tm.pensieve.common: Represents a Unit of Translation's Variant.
TranslationUnitVariant() - Constructor for class net.sf.okapi.tm.pensieve.common.TranslationUnitVariant: Creates an empty TUV
TranslationUnitVariant(LocaleId, TextFragment) - Constructor for class net.sf.okapi.tm.pensieve.common.TranslationUnitVariant: Creates a TUV with the given language and content

U

update(TranslationUnit) - Method in interface net.sf.okapi.tm.pensieve.writer.ITmWriter: Updates a TranslationUnit.
update(TranslationUnit) - Method in class net.sf.okapi.tm.pensieve.writer.PensieveWriter: Updates a TranslationUnit.

V

valueOf(String) - Static method in enum net.sf.okapi.tm.pensieve.common.MetadataType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.sf.okapi.tm.pensieve.common.TranslationUnitField: Returns the enum constant of this type with the specified name.
values() - Static method in enum net.sf.okapi.tm.pensieve.common.MetadataType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.sf.okapi.tm.pensieve.common.TranslationUnitField: Returns an array containing the constants of this enum type, in the order they are declared.

C D E F G H I M N O P S T U V