net.sf.extjwnl.princeton.file

Class PrincetonRandomAccessDictionaryFile

java.lang.Object

net.sf.extjwnl.dictionary.file.AbstractDictionaryFile

net.sf.extjwnl.princeton.file.AbstractPrincetonDictionaryFile

net.sf.extjwnl.princeton.file.AbstractPrincetonRandomAccessDictionaryFile

net.sf.extjwnl.princeton.file.PrincetonRandomAccessDictionaryFile

All Implemented Interfaces:

DictionaryDiskFile, DictionaryFile, DictionaryFileFactory<PrincetonRandomAccessDictionaryFile>, RandomAccessDictionaryFile, Owned

public class PrincetonRandomAccessDictionaryFile
extends AbstractPrincetonRandomAccessDictionaryFile
implements DictionaryFileFactory<PrincetonRandomAccessDictionaryFile>, DictionaryDiskFile

A RandomAccessDictionaryFile that accesses files named with Princeton's dictionary file naming convention.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHECK_DATA_FILE_LINE_LENGTH_LIMIT_KEY Whether to warn about data file line length being off limits, default: true.
static java.lang.String	CHECK_LEX_FILE_NUMBER_KEY Whether to warn about lex file numbers correctness, default: true.
static java.lang.String	CHECK_LEX_ID_LIMIT_KEY Whether to warn about lex id being off limits, default: true.
static java.lang.String	CHECK_POINTER_INDEX_LIMIT_KEY Whether to warn about pointer target indices being off limits, default: true
static java.lang.String	CHECK_RELATION_LIMIT_KEY Whether to warn about relation count being off limits, default: true.
static java.lang.String	CHECK_VERB_FRAME_LIMIT_KEY Whether to warn about verb frame indices being off limits, default: true
static java.lang.String	CHECK_WORD_COUNT_LIMIT_KEY Whether to warn about word count being off limits, default: true.
protected java.io.File	file
protected java.io.RandomAccessFile	raFile
protected long	raFileLength
static java.lang.String	WRITE_PRINCETON_HEADER_KEY Whether to add standard princeton header to files on save, default: false.

Fields inherited from class net.sf.extjwnl.princeton.file.AbstractPrincetonRandomAccessDictionaryFile

encoding, ENCODING_KEY

Fields inherited from class net.sf.extjwnl.dictionary.file.AbstractDictionaryFile

dictionary, fileType, params, path, pos

Constructor Summary

Constructors

Constructor and Description
PrincetonRandomAccessDictionaryFile(Dictionary dictionary, java.util.Map<java.lang.String,Param> params) Factory constructor.
PrincetonRandomAccessDictionaryFile(Dictionary dictionary, java.lang.String path, POS pos, DictionaryFileType fileType, java.util.Map<java.lang.String,Param> params) Instance constructor.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the file.
boolean	delete() Deletes the file.
void	edit() Reopens file in write mode.
static void	formatOffset(long i, int formatLength, java.lang.StringBuilder target)
java.io.File	getFile() Returns the file.
long	getFirstLineOffset() Returns offset of the first line.
long	getNextLineOffset(long offset) Returns start of the next line or -1 if no new line.
int	getOffsetLength() Returns offset length that accommodates largest offset.
protected PointedCharSequence	getPointedCharSequence(long offset, byte[] line, int i)
protected boolean	isInvalidOffset(long offset)
boolean	isOpen() Returns true if the file is open.
long	length() Returns the length, in bytes, of the file.
PrincetonRandomAccessDictionaryFile	newInstance(Dictionary dictionary, java.lang.String path, POS pos, DictionaryFileType fileType) Creates a new instance of dictionary file.
void	open() Opens the file.
PointedCharSequence	readLine(long offset) Reads starting at offset and till the end of line.
PointedCharSequence	readWord(long offset) Reads starting at offset and till space.
void	save() Saves the file.
void	setOffsetLength(int length) Sets offset length to be used while rendering the file.
protected void	writePrincetonHeader()

Methods inherited from class net.sf.extjwnl.princeton.file.AbstractPrincetonDictionaryFile

getFilename

Methods inherited from class net.sf.extjwnl.dictionary.file.AbstractDictionaryFile

getDictionary, getFileType, getPOS, setDictionary

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.extjwnl.dictionary.file.DictionaryFile

getFilename, getFileType, getPOS

Methods inherited from interface net.sf.extjwnl.util.factory.Owned

getDictionary, setDictionary

Field Detail

WRITE_PRINCETON_HEADER_KEY

public static final java.lang.String WRITE_PRINCETON_HEADER_KEY

Whether to add standard princeton header to files on save, default: false.

See Also:

Constant Field Values

CHECK_LEX_FILE_NUMBER_KEY

public static final java.lang.String CHECK_LEX_FILE_NUMBER_KEY

Whether to warn about lex file numbers correctness, default: true.

See Also:

Constant Field Values

CHECK_RELATION_LIMIT_KEY

public static final java.lang.String CHECK_RELATION_LIMIT_KEY

Whether to warn about relation count being off limits, default: true.

See Also:

Constant Field Values

CHECK_WORD_COUNT_LIMIT_KEY

public static final java.lang.String CHECK_WORD_COUNT_LIMIT_KEY

Whether to warn about word count being off limits, default: true.

See Also:

Constant Field Values

CHECK_LEX_ID_LIMIT_KEY

public static final java.lang.String CHECK_LEX_ID_LIMIT_KEY

Whether to warn about lex id being off limits, default: true.

See Also:

Constant Field Values

CHECK_POINTER_INDEX_LIMIT_KEY

public static final java.lang.String CHECK_POINTER_INDEX_LIMIT_KEY

Whether to warn about pointer target indices being off limits, default: true

See Also:

Constant Field Values

CHECK_VERB_FRAME_LIMIT_KEY

public static final java.lang.String CHECK_VERB_FRAME_LIMIT_KEY

Whether to warn about verb frame indices being off limits, default: true

See Also:

Constant Field Values

CHECK_DATA_FILE_LINE_LENGTH_LIMIT_KEY

public static final java.lang.String CHECK_DATA_FILE_LINE_LENGTH_LIMIT_KEY

Whether to warn about data file line length being off limits, default: true. The line length was found empirically by testing wnb.exe for crashes. It equals 15360.

See Also:

Constant Field Values

file

protected final java.io.File file

raFile

protected java.io.RandomAccessFile raFile

raFileLength

protected long raFileLength

Constructor Detail

PrincetonRandomAccessDictionaryFile

public PrincetonRandomAccessDictionaryFile(Dictionary dictionary,
                                           java.util.Map<java.lang.String,Param> params)

Factory constructor.

Parameters:

dictionary - dictionary

params - params

PrincetonRandomAccessDictionaryFile

public PrincetonRandomAccessDictionaryFile(Dictionary dictionary,
                                           java.lang.String path,
                                           POS pos,
                                           DictionaryFileType fileType,
                                           java.util.Map<java.lang.String,Param> params)

Instance constructor.

Parameters:

dictionary - dictionary

path - file path

pos - part of speech

fileType - file type

params - params

Method Detail

formatOffset

public static void formatOffset(long i,
                                int formatLength,
                                java.lang.StringBuilder target)

newInstance

public PrincetonRandomAccessDictionaryFile newInstance(Dictionary dictionary,
                                                       java.lang.String path,
                                                       POS pos,
                                                       DictionaryFileType fileType)

Description copied from interface: DictionaryFileFactory

Creates a new instance of dictionary file.

Specified by:

newInstance in interface DictionaryFileFactory<PrincetonRandomAccessDictionaryFile>

Parameters:

dictionary - owner dictionary

path - path to dictionary files

pos - part of speech

fileType - file type

Returns:

a new instance of the dictionary file

readLine

public PointedCharSequence readLine(long offset)
                             throws JWNLException

Description copied from interface: RandomAccessDictionaryFile

Reads starting at offset and till the end of line.

Specified by:

readLine in interface RandomAccessDictionaryFile

Parameters:

offset - offset

Returns:

a line from the file

Throws:

JWNLException - JWNLException

readWord

public PointedCharSequence readWord(long offset)
                             throws JWNLException

Description copied from interface: RandomAccessDictionaryFile

Reads starting at offset and till space.

Specified by:

readWord in interface RandomAccessDictionaryFile

Parameters:

offset - offset

Returns:

one word from the file (e.g. offset, index word)

Throws:

JWNLException - JWNLException

getFirstLineOffset

public long getFirstLineOffset()
                        throws JWNLException

Description copied from interface: RandomAccessDictionaryFile

Returns offset of the first line.

Specified by:

getFirstLineOffset in interface RandomAccessDictionaryFile

Returns:

offset of the first line

Throws:

JWNLException - JWNLException

getNextLineOffset

public long getNextLineOffset(long offset)
                       throws JWNLException

Description copied from interface: RandomAccessDictionaryFile

Returns start of the next line or -1 if no new line.

Specified by:

getNextLineOffset in interface RandomAccessDictionaryFile

Parameters:

offset - starting offset

Returns:

start of the next line or -1 if no new line.

Throws:

JWNLException - JWNLException

open

public void open()
          throws JWNLException

Description copied from interface: DictionaryFile

Opens the file.

Specified by:

open in interface DictionaryFile

Throws:

JWNLException - JWNLException

isOpen

public boolean isOpen()

Description copied from interface: DictionaryFile

Returns true if the file is open.

Specified by:

isOpen in interface DictionaryFile

Returns:

true if the file is open

close

public void close()
           throws JWNLException

Description copied from interface: DictionaryFile

Closes the file.

Specified by:

close in interface DictionaryFile

Throws:

JWNLException - JWNLException

edit

public void edit()
          throws JWNLException

Description copied from interface: DictionaryFile

Reopens file in write mode.

Specified by:

edit in interface DictionaryFile

Throws:

JWNLException - JWNLException

length

public long length()
            throws JWNLException

Description copied from interface: RandomAccessDictionaryFile

Returns the length, in bytes, of the file.

Specified by:

length in interface RandomAccessDictionaryFile

Returns:

the length, in bytes, of the file

Throws:

JWNLException - JWNLException

save

public void save()
          throws JWNLException

Description copied from interface: DictionaryFile

Saves the file.

Specified by:

save in interface DictionaryFile

Throws:

JWNLException - JWNLException

getOffsetLength

public int getOffsetLength()
                    throws JWNLException

Description copied from interface: RandomAccessDictionaryFile

Returns offset length that accommodates largest offset.

Specified by:

getOffsetLength in interface RandomAccessDictionaryFile

Returns:

offset length that accommodates largest offset

Throws:

JWNLException - JWNLException

setOffsetLength

public void setOffsetLength(int length)
                     throws JWNLException

Description copied from interface: RandomAccessDictionaryFile

Sets offset length to be used while rendering the file.

Specified by:

setOffsetLength in interface RandomAccessDictionaryFile

Parameters:

length - offset length to be used while rendering the file

Throws:

JWNLException - JWNLException

getFile

public java.io.File getFile()

Description copied from interface: DictionaryDiskFile

Returns the file.

Specified by:

getFile in interface DictionaryDiskFile

Returns:

the file

delete

public boolean delete()
               throws JWNLException

Description copied from interface: DictionaryDiskFile

Deletes the file.

Specified by:

delete in interface DictionaryDiskFile

Returns:

true if succeeded

Throws:

JWNLException - JWNLException

getPointedCharSequence

protected PointedCharSequence getPointedCharSequence(long offset,
                                                     byte[] line,
                                                     int i)
                                              throws JWNLIOException

Throws:

JWNLIOException

isInvalidOffset

protected boolean isInvalidOffset(long offset)
                           throws JWNLException

Throws:

JWNLException

writePrincetonHeader

protected void writePrincetonHeader()
                             throws java.io.IOException

Throws:

java.io.IOException