net.sf.extjwnl.princeton.file

Class AbstractPrincetonObjectDictionaryFile

java.lang.Object

net.sf.extjwnl.dictionary.file.AbstractDictionaryFile

net.sf.extjwnl.princeton.file.AbstractPrincetonDictionaryFile

net.sf.extjwnl.princeton.file.AbstractPrincetonObjectDictionaryFile

All Implemented Interfaces:

DictionaryFile, ObjectDictionaryFile, Owned

Direct Known Subclasses:

PrincetonObjectDictionaryFile, PrincetonResourceObjectDictionaryFile

public abstract class AbstractPrincetonObjectDictionaryFile
extends AbstractPrincetonDictionaryFile
implements ObjectDictionaryFile

Parent for ObjectDictionaryFiles that access files with the Princeton dictionary file naming convention.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.io.ObjectInputStream	in
protected java.io.ObjectOutputStream	out

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

dictionary, fileType, params, path, pos

Constructor Summary

Constructors

Modifier	Constructor and Description
	AbstractPrincetonObjectDictionaryFile(Dictionary dictionary, java.util.Map<java.lang.String,Param> params) Factory constructor.
protected	AbstractPrincetonObjectDictionaryFile(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
protected boolean	canRead()
protected boolean	canWrite()
void	close() Closes the file.
protected void	closeStreams(java.io.InputStream in, java.io.OutputStream out)
void	edit() Reopens file in write mode.
protected java.io.ObjectInputStream	getInputStream()
protected java.io.ObjectOutputStream	getOutputStream()
boolean	isOpen() Returns true if the file is open.
abstract void	open() Here we try to be intelligent about opening streams.
protected abstract void	openInputStream()
protected abstract void	openOutputStream()
protected void	openStreams() Open the input and output streams.
java.lang.Object	readObject() Reads and deserializes an object from the file.
void	save() Saves the file.
void	writeObject(java.lang.Object obj) Serializes and write an object ot 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

Field Detail

in

protected java.io.ObjectInputStream in

out

protected java.io.ObjectOutputStream out

Constructor Detail

AbstractPrincetonObjectDictionaryFile

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

Factory constructor.

Parameters:

dictionary - dictionary

params - params

AbstractPrincetonObjectDictionaryFile

protected AbstractPrincetonObjectDictionaryFile(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

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

save

public void save()
          throws JWNLException

Description copied from interface: DictionaryFile

Saves the file.

Specified by:

save in interface DictionaryFile

Throws:

JWNLException - JWNLException

close

public void close()

Description copied from interface: DictionaryFile

Closes the file.

Specified by:

close in interface DictionaryFile

closeStreams

protected void closeStreams(java.io.InputStream in,
                            java.io.OutputStream out)
                     throws java.io.IOException

Throws:

java.io.IOException

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

openStreams

protected void openStreams()
                    throws JWNLException

Open the input and output streams.

Throws:

JWNLException - JWNLException

openOutputStream

protected abstract void openOutputStream()
                                  throws JWNLException

Throws:

JWNLException

openInputStream

protected abstract void openInputStream()
                                 throws JWNLException

Throws:

JWNLException

getInputStream

protected java.io.ObjectInputStream getInputStream()
                                            throws JWNLException

Throws:

JWNLException

getOutputStream

protected java.io.ObjectOutputStream getOutputStream()
                                              throws JWNLException

Throws:

JWNLException

canRead

protected boolean canRead()

canWrite

protected boolean canWrite()

readObject

public java.lang.Object readObject()
                            throws JWNLException

Description copied from interface: ObjectDictionaryFile

Reads and deserializes an object from the file.

Specified by:

readObject in interface ObjectDictionaryFile

Returns:

deserialized an object

Throws:

JWNLException - JWNLException

writeObject

public void writeObject(java.lang.Object obj)
                 throws JWNLException

Description copied from interface: ObjectDictionaryFile

Serializes and write an object ot the file.

Specified by:

writeObject in interface ObjectDictionaryFile

Parameters:

obj - object to write

Throws:

JWNLException - JWNLException

open

public abstract void open()
                   throws JWNLException

Here we try to be intelligent about opening streams. If the file does not already exist, we assume that we are going to be creating it and writing to it, otherwise we assume that we are going to be reading from it. If you want the other stream open, you must do it explicitly by calling openStreams.

Specified by:

open in interface DictionaryFile

Throws:

JWNLException - JWNLException