A B C D E F G H I L M N O P R S U V W

A

ADDRESS_OFFSET - Static variable in class morfologik.fsa.FSA5

An offset in the arc structure, where the address and flags field begins.

annotation - Variable in class morfologik.fsa.FSA5

Annotation character.

arcs - Variable in class morfologik.fsa.CFSA

An array of bytes with the internal representation of the automaton.

arcs - Variable in class morfologik.fsa.FSA5

An array of bytes with the internal representation of the automaton.

arcsCount - Variable in class morfologik.fsa.FSAInfo

Number of arcs in the automaton, excluding an arcs from the zero node (initial) and an arc from the start node to the root node.

arcsCountTotal - Variable in class morfologik.fsa.FSAInfo

Total number of arcs, counting arcs that physically overlap due to merging.

Arrays - Class in morfologik.util

Compatibility layer for JVM 1.5.

assertExists(File, boolean, boolean) - Static method in class morfologik.util.FileUtils

Checks if the given file exists.

ATTR_NAME_ENCODING - Static variable in class morfologik.stemming.DictionaryMetadata

Attribute name for DictionaryMetadata.encoding.

ATTR_NAME_SEPARATOR - Static variable in class morfologik.stemming.DictionaryMetadata

Attribute name for DictionaryMetadata.separator.

ATTR_NAME_USES_INFIXES - Static variable in class morfologik.stemming.DictionaryMetadata

Attribute name for DictionaryMetadata.usesInfixes.

ATTR_NAME_USES_PREFIXES - Static variable in class morfologik.stemming.DictionaryMetadata

Attribute name for DictionaryMetadata.usesPrefixes.

B

BIT_FINAL_ARC - Static variable in class morfologik.fsa.CFSA

Bitmask indicating that an arc corresponds to the last character of a sequence available when building the automaton.

BIT_FINAL_ARC - Static variable in class morfologik.fsa.FSA5

Bit indicating that an arc corresponds to the last character of a sequence available when building the automaton.

BIT_LAST_ARC - Static variable in class morfologik.fsa.CFSA

Bitmask indicating that an arc is the last one of the node's list and the following one belongs to another node.

BIT_LAST_ARC - Static variable in class morfologik.fsa.FSA5

Bit indicating that an arc is the last one of the node's list and the following one belongs to another node.

BIT_TARGET_NEXT - Static variable in class morfologik.fsa.CFSA

Bitmask indicating that the target node of this arc follows it in the compressed automaton structure (no goto field).

BIT_TARGET_NEXT - Static variable in class morfologik.fsa.FSA5

Bit indicating that the target node of this arc follows it in the compressed automaton structure (no goto field).

bits - Variable in enum morfologik.fsa.FSAFlags

Bit mask for the corresponding flag.

BufferUtils - Class in morfologik.util

Utility functions for buffers.

C

CFSA - Class in morfologik.fsa

CFSA (Compact Finite State Automaton) binary format implementation.

CFSA(InputStream) - Constructor for class morfologik.fsa.CFSA

Creates a new automaton reading it from a file in FSA format, version 5.

CFSAEncoder - Class in morfologik.fsa

Re-encode FSA5 automaton to a more compact representation (CFSA).

clone() - Method in class morfologik.stemming.WordData

Declare a covariant of Object.clone() that returns a deep copy of this object.

close(Closeable...) - Static method in class morfologik.util.FileUtils

Force any non-null closeables.

convert(InputStream, OutputStream) - Static method in class morfologik.fsa.CFSAEncoder

Convert FSA in version 5 to CFSA.

copyOf(byte[], int) - Static method in class morfologik.util.Arrays

copyOf(int[], int) - Static method in class morfologik.util.Arrays

copyOf(T[], int) - Static method in class morfologik.util.Arrays

copyOf(U[], int, Class<? extends T[]>) - Static method in class morfologik.util.Arrays

D

decodeStem(ByteBuffer, byte[], int, ByteBuffer, DictionaryMetadata) - Static method in class morfologik.stemming.DictionaryLookup

Decode the base form of an inflected word and save its decoded form into a byte buffer.

defaultDictionaries - Static variable in class morfologik.stemming.Dictionary

Default loaded dictionaries.

Dictionary - Class in morfologik.stemming

A dictionary combines FSA automaton and metadata describing the internals of dictionary entries' coding (DictionaryMetadata.

Dictionary(FSA, DictionaryMetadata) - Constructor for class morfologik.stemming.Dictionary

It is strongly recommended to use static methods in this class for reading dictionaries.

DictionaryIterator - Class in morfologik.stemming

An iterator over WordData entries of a Dictionary.

DictionaryIterator(Dictionary, CharsetDecoder, boolean) - Constructor for class morfologik.stemming.DictionaryIterator

DictionaryLookup - Class in morfologik.stemming

This class implements a dictionary lookup over an FSA dictionary.

DictionaryLookup(Dictionary) - Constructor for class morfologik.stemming.DictionaryLookup

Creates a new object of this class using the given FSA for word lookups and encoding for converting characters to bytes.

DictionaryMetadata - Class in morfologik.stemming

Description of attributes, their types and default values.

DictionaryMetadata(char, String, boolean, boolean, Map<String, String>) - Constructor for class morfologik.stemming.DictionaryMetadata

Creates an immutable instance of DictionaryMetadata.

doLabelMapping() - Method in class morfologik.fsa.CFSAEncoder

Attempt to fit labels into the flags field in arcs with NEXT bit set.

DumpTool - Class in morfologik.tools

This utility will dump the information and contents of a given FSA dictionary.

DumpTool() - Constructor for class morfologik.tools.DumpTool

E

encoding - Variable in class morfologik.stemming.DictionaryMetadata

Encoding used for converting bytes to characters and vice versa.

ensureCapacity(ByteBuffer, int) - Static method in class morfologik.util.BufferUtils

Ensure the byte buffer's capacity.

ensureCapacity(CharBuffer, int) - Static method in class morfologik.util.BufferUtils

Ensure the char buffer's capacity.

equals(Object) - Method in class morfologik.stemming.WordData

F

FileUtils - Class in morfologik.util

Utility functions.

filler - Variable in class morfologik.fsa.FSA5

Filler character.

finalStatesCount - Variable in class morfologik.fsa.FSAInfo

Number of final states (number of input sequences stored in the automaton).

FSA - Class in morfologik.fsa

This is a top interface for walking Finite State Automata as described in Jan Daciuk's Incremental Construction of Finite-State Automata and Transducers, and Their Use in the Natural Language Processing (PhD thesis, Technical University of Gdansk).

FSA() - Constructor for class morfologik.fsa.FSA

fsa - Variable in class morfologik.stemming.Dictionary

FSA automaton with the compiled dictionary data.

FSA2CFSA - Class in morfologik.tools

Convert from FSA5 to CFSA format.

FSA2CFSA() - Constructor for class morfologik.tools.FSA2CFSA

FSA5 - Class in morfologik.fsa

FSA binary format implementation for version 5.

FSA5(InputStream) - Constructor for class morfologik.fsa.FSA5

Read and wrap a binary automaton in FSA version 5.

FSAFinalStatesIterator - Class in morfologik.fsa

An iterator that traverses all final states reachable from a given node and returns byte sequences corresponding to final states.

FSAFlags - Enum in morfologik.fsa

FSA automaton flags.

FSAInfo - Class in morfologik.fsa

Compute additional information about an FSA: number of arcs, nodes, etc.

FSAInfo(FSA) - Constructor for class morfologik.fsa.FSAInfo

FSAMatch - Class in morfologik.fsa

A matching result returned from FSATraversalHelper.

FSAMatch() - Constructor for class morfologik.fsa.FSAMatch

FSAMatchType - Enum in morfologik.fsa

Type of the match returned as part of FSAMatch.

FSATraversalHelper - Class in morfologik.fsa

This class implements some common matching and scanning operations on a generic FSA.

G

getAllSubsequences(int) - Method in class morfologik.fsa.FSATraversalHelper

Returns an Iterator of all subsequences available from the given node to all reachable final states.

getArc(int, byte) - Method in class morfologik.fsa.CFSA

Returns the identifier of an arc leaving node and labeled with label.

getArc(int, byte) - Method in class morfologik.fsa.FSA

Returns the identifier of an arc leaving node and labeled with label.

getArc(int, byte) - Method in class morfologik.fsa.FSA5

Returns the identifier of an arc leaving node and labeled with label.

getArcLabel(int) - Method in class morfologik.fsa.CFSA

Return the label associated with a given arc.

getArcLabel(int) - Method in class morfologik.fsa.FSA

Return the label associated with a given arc.

getArcLabel(int) - Method in class morfologik.fsa.FSA5

Return the label associated with a given arc.

getDestinationNodeOffset(int) - Method in class morfologik.fsa.CFSA

Returns the address of the node pointed to by this arc.

getDestinationNodeOffset(int) - Method in class morfologik.fsa.FSA5

Returns the address of the node pointed to by this arc.

getDictionary() - Method in class morfologik.stemming.DictionaryLookup

getEndNode(int) - Method in class morfologik.fsa.CFSA

Return the end node pointed to by a given arc.

getEndNode(int) - Method in class morfologik.fsa.FSA

Return the end node pointed to by a given arc.

getEndNode(int) - Method in class morfologik.fsa.FSA5

Return the end node pointed to by a given arc.

getExpectedFeaturesName(String) - Static method in class morfologik.stemming.Dictionary

Returns the expected name of the metadata file, based on the name of the FSA dictionary file.

getFinalStatesIterator() - Method in class morfologik.fsa.FSATraversalHelper

Returns a new iterator for walking along the final states of this FSA.

getFirstArc(int) - Method in class morfologik.fsa.CFSA

Returns the identifier of the first arc leaving node or 0 if the node has no outgoing arcs.

getFirstArc(int) - Method in class morfologik.fsa.FSA

Returns the identifier of the first arc leaving node or 0 if the node has no outgoing arcs.

getFirstArc(int) - Method in class morfologik.fsa.FSA5

Returns the identifier of the first arc leaving node or 0 if the node has no outgoing arcs.

getFlags() - Method in class morfologik.fsa.CFSA

Returns a set of flags for this FSA instance.

getFlags() - Method in class morfologik.fsa.FSA

Returns a set of flags for this FSA instance.

getFlags() - Method in class morfologik.fsa.FSA5

Returns a set of flags for this FSA instance.

getForLanguage(String) - Static method in class morfologik.stemming.Dictionary

Return a built-in dictionary for a given ISO language code.

getInstance(InputStream) - Static method in class morfologik.fsa.FSA

A factory for reading automata in any library-supported version.

getMatchType() - Method in class morfologik.fsa.FSAMatch

Return match type.

getMismatchIndex() - Method in class morfologik.fsa.FSAMatch

Return the index at which a mismatch occurred.

getMismatchNode() - Method in class morfologik.fsa.FSAMatch

Return the node at which mismatch occurred.

getNextArc(int) - Method in class morfologik.fsa.CFSA

Returns the identifier of the next arc after arc and leaving node.

getNextArc(int) - Method in class morfologik.fsa.FSA

Returns the identifier of the next arc after arc and leaving node.

getNextArc(int) - Method in class morfologik.fsa.FSA5

Returns the identifier of the next arc after arc and leaving node.

getRootNode() - Method in class morfologik.fsa.CFSA

Returns the start node of this automaton.

getRootNode() - Method in class morfologik.fsa.FSA

Returns the identifier of the root node of this automaton.

getRootNode() - Method in class morfologik.fsa.FSA5

Returns the start node of this automaton.

getStem() - Method in class morfologik.stemming.WordData

getStemBytes(ByteBuffer) - Method in class morfologik.stemming.WordData

Copy the stem's binary data (no charset decoding) to a custom byte buffer.

getTag() - Method in class morfologik.stemming.WordData

getTagBytes(ByteBuffer) - Method in class morfologik.stemming.WordData

Copy the tag's binary data (no charset decoding) to a custom byte buffer.

getTraversalHelper() - Method in class morfologik.fsa.FSA

Returns an object which can be used to walk the edges of this finite state automaton and match arbitrary sequences against its states.

getWord() - Method in class morfologik.stemming.WordData

getWordBytes(ByteBuffer) - Method in class morfologik.stemming.WordData

Copy the inflected word's binary data (no charset decoding) to a custom byte buffer.

go(CommandLine) - Method in class morfologik.tools.DumpTool

Command line entry point after parsing arguments.

go(CommandLine) - Method in class morfologik.tools.FSA2CFSA

Command line entry point after parsing arguments.

gtl - Variable in class morfologik.fsa.CFSA

Number of bytes each address takes in full, expanded form (goto length).

gtl - Variable in class morfologik.fsa.FSA5

Number of bytes each address takes in full, expanded form (goto length).

H

hashCode() - Method in class morfologik.stemming.WordData

hasNext() - Method in class morfologik.fsa.FSAFinalStatesIterator

Returns true if there are still elements in this iterator.

hasNext() - Method in class morfologik.stemming.DictionaryIterator

I

inflectionFrames() - Method in class morfologik.tools.InflectionFramesTool

InflectionFramesTool - Class in morfologik.tools

Calculate inflection frames from the Polish dictionary.

InflectionFramesTool() - Constructor for class morfologik.tools.InflectionFramesTool

initializeOptions(Options) - Method in class morfologik.tools.DumpTool

Command line options for the tool.

initializeOptions(Options) - Method in class morfologik.tools.FSA2CFSA

isArcFinal(int) - Method in class morfologik.fsa.CFSA

Returns true if the destination node at the end of this arc corresponds to an input sequence created when building this automaton.

isArcFinal(int) - Method in class morfologik.fsa.FSA

Returns true if the destination node at the end of this arc corresponds to an input sequence created when building this automaton.

isArcFinal(int) - Method in class morfologik.fsa.FSA5

Returns true if the destination node at the end of this arc corresponds to an input sequence created when building this automaton.

isArcLast(int) - Method in class morfologik.fsa.CFSA

Returns true if this arc has NEXT bit set.

isArcLast(int) - Method in class morfologik.fsa.FSA5

Returns true if this arc has NEXT bit set.

isArcTerminal(int) - Method in class morfologik.fsa.CFSA

Returns true if this arc does not have a terminating node (@link FSA.getEndNode(int) will throw an exception).

isArcTerminal(int) - Method in class morfologik.fsa.FSA

Returns true if this arc does not have a terminating node (@link FSA.getEndNode(int) will throw an exception).

isArcTerminal(int) - Method in class morfologik.fsa.FSA5

Returns true if this arc does not have a terminating node (@link FSA.getEndNode(int) will throw an exception).

isLabelCompressed(int) - Method in class morfologik.fsa.CFSA

Returns true if the label is compressed inside flags byte.

isNextSet(int) - Method in class morfologik.fsa.CFSA

isNextSet(int) - Method in class morfologik.fsa.FSA5

isSet(int, FSAFlags) - Static method in enum morfologik.fsa.FSAFlags

Returns true if the corresponding flag is set in the bit set.

IStemmer - Interface in morfologik.stemming

A generic "stemmer" interface in Morfologik.

iterator() - Method in class morfologik.fsa.FSA

Returns an iterator over all binary sequences starting from the initial FSA state and ending in final nodes.

iterator() - Method in class morfologik.stemming.DictionaryLookup

Return an iterator over all WordData entries available in the embedded Dictionary.

iterator() - Method in class morfologik.stemming.PolishStemmer

Iterates over all dictionary forms stored in this stemmer.

L

labelMapping - Variable in class morfologik.fsa.CFSA

Label mapping for arcs of type (1) (see class documentation).

Launcher - Class in morfologik.tools

A launcher for other command-line tools.

Launcher() - Constructor for class morfologik.tools.Launcher

lookup(CharSequence) - Method in class morfologik.stemming.DictionaryLookup

Searches the automaton for a symbol sequence equal to word, followed by a separator.

lookup(CharSequence) - Method in interface morfologik.stemming.IStemmer

Returns a list of WordData entries for a given word.

lookup(CharSequence) - Method in class morfologik.stemming.PolishStemmer

Returns a list of WordData entries for a given word.

M

main(String[]) - Static method in class morfologik.tools.DumpTool

Command line entry point.

main(String[]) - Static method in class morfologik.tools.FSA2CFSA

Command line entry point.

main(String[]) - Static method in class morfologik.tools.InflectionFramesTool

main(String[]) - Static method in class morfologik.tools.Launcher

Command line entry point.

matchSequence(FSAMatch, byte[], int, int, int) - Method in class morfologik.fsa.FSATraversalHelper

Same as FSATraversalHelper.matchSequence(byte[], int, int, int), but allows passing a reusable FSAMatch object so that no intermediate garbage is produced.

matchSequence(byte[], int, int, int) - Method in class morfologik.fsa.FSATraversalHelper

Finds a matching path in the dictionary for a given sequence of labels from sequence and starting at node node.

matchSequence(byte[], int) - Method in class morfologik.fsa.FSATraversalHelper

matchSequence(byte[]) - Method in class morfologik.fsa.FSATraversalHelper

metadata - Variable in class morfologik.stemming.Dictionary

Metadata associated with the dictionary.

metadata - Variable in class morfologik.stemming.DictionaryMetadata

Other meta data not included above.

METADATA_FILE_EXTENSION - Static variable in class morfologik.stemming.Dictionary

Expected metadata file extension.

morfologik.fsa - package morfologik.fsa

morfologik.stemming - package morfologik.stemming

morfologik.tools - package morfologik.tools

morfologik.util - package morfologik.util

N

next() - Method in class morfologik.fsa.FSAFinalStatesIterator

next() - Method in class morfologik.stemming.DictionaryIterator

nodeCount - Variable in class morfologik.fsa.FSAInfo

Number of nodes in the automaton.

nodeDataLength - Variable in class morfologik.fsa.CFSA

The length of the node header structure (if the automaton was compiled with NUMBERS option).

nodeDataLength - Variable in class morfologik.fsa.FSA5

The length of the node header structure (if the automaton was compiled with NUMBERS option).

O

openInputStream(String) - Static method in class morfologik.util.ResourceUtils

Returns an input stream to the resource.

P

PolishStemmer - Class in morfologik.stemming

A dictionary-based stemmer for the Polish language.

PolishStemmer() - Constructor for class morfologik.stemming.PolishStemmer

This constructor is initialized with a built-in dictionary or fails with a runtime exception if the dictionary is not available.

printUsage() - Method in class morfologik.tools.FSA2CFSA

R

read(File) - Static method in class morfologik.stemming.Dictionary

Attempts to load a dictionary using the path to the FSA file and the expected metadata extension.

read(URL) - Static method in class morfologik.stemming.Dictionary

Attempts to load a dictionary using the URL to the FSA file and the expected metadata extension.

readAndClose(InputStream, InputStream) - Static method in class morfologik.stemming.Dictionary

Attempts to load a dictionary from opened streams of FSA dictionary data and associated metadata.

readByte(InputStream) - Static method in class morfologik.util.FileUtils

Read exactly one byte from the input stream.

readFully(InputStream) - Static method in class morfologik.util.FileUtils

Reads all bytes from an input stream (until EOF).

readFully(InputStream, byte[]) - Static method in class morfologik.util.FileUtils

Read enough bytes to fill array If there are not enough bytes, throw an exception.

readInt(InputStream) - Static method in class morfologik.util.FileUtils

Read exactly 4 bytes from the input stream.

remove() - Method in class morfologik.fsa.FSAFinalStatesIterator

Not implemented in this iterator.

remove() - Method in class morfologik.stemming.DictionaryIterator

ResourceUtils - Class in morfologik.util

Resource management utilities.

restartFrom(int) - Method in class morfologik.fsa.FSAFinalStatesIterator

Restart walking from node.

S

separator - Variable in class morfologik.stemming.DictionaryMetadata

A separator character between fields (stem, lemma, form).

serialize(OutputStream) - Method in class morfologik.fsa.CFSAEncoder

Serialize the current representation of the automaton.

U

updateOffsets() - Method in class morfologik.fsa.CFSAEncoder

Update node offsets according to their current states and encoding schemes.

usesInfixes - Variable in class morfologik.stemming.DictionaryMetadata

True if the dictionary was compiled with infix compression.

usesPrefixes - Variable in class morfologik.stemming.DictionaryMetadata

True if the dictionary was compiled with prefix compression.

V

valueOf(String) - Static method in enum morfologik.fsa.FSAFlags

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum morfologik.fsa.FSAMatchType

Returns the enum constant of this type with the specified name.

values() - Static method in enum morfologik.fsa.FSAFlags

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum morfologik.fsa.FSAMatchType

Returns an array containing the constants of this enum type, in the order they are declared.

VERSION - Static variable in class morfologik.fsa.CFSA

Automaton header version value.

VERSION - Static variable in class morfologik.fsa.FSA5

Automaton version as in the file header.

W

WordData - Class in morfologik.stemming

Stem and tag data associated with a given word.

A B C D E F G H I L M N O P R S U V W