net.sf.extjwnl.princeton.file

Class PrincetonResourceDictionaryFile

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.PrincetonResourceDictionaryFile

All Implemented Interfaces:

DictionaryFile, DictionaryFileFactory<PrincetonResourceDictionaryFile>, RandomAccessDictionaryFile, Owned

public class PrincetonResourceDictionaryFile
extends AbstractPrincetonRandomAccessDictionaryFile
implements DictionaryFileFactory<PrincetonResourceDictionaryFile>

Loads dictionary files from classpath.

Field Summary

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
PrincetonResourceDictionaryFile(Dictionary dictionary, java.util.Map<java.lang.String,Param> params) Factory constructor.
PrincetonResourceDictionaryFile(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.
static void	copyStream(java.io.InputStream input, java.io.OutputStream output)
void	edit() Reopens file in write mode.
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.
boolean	isOpen() Returns true if the file is open.
long	length() Returns the length, in bytes, of the file.
PrincetonResourceDictionaryFile	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.

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

Constructor Detail

PrincetonResourceDictionaryFile

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

Factory constructor.

Parameters:

dictionary - dictionary

params - params

PrincetonResourceDictionaryFile

public PrincetonResourceDictionaryFile(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

newInstance

public PrincetonResourceDictionaryFile 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<PrincetonResourceDictionaryFile>

Parameters:

dictionary - owner dictionary

path - path to dictionary files

pos - part of speech

fileType - file type

Returns:

a new instance of the dictionary file

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()

Description copied from interface: DictionaryFile

Closes the file.

Specified by:

close in interface DictionaryFile

save

public void save()
          throws JWNLException

Description copied from interface: DictionaryFile

Saves the file.

Specified by:

save 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

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

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

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

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

copyStream

public static void copyStream(java.io.InputStream input,
                              java.io.OutputStream output)
                       throws java.io.IOException

Throws:

java.io.IOException