NearOCR

Class Document

java.lang.Object

NearOCR.Document

public class Document
extends java.lang.Object

Retains information specific to one document. This can be saved and loaded to retain all information.

A document consists of an image and a Vector of letters, which represent position, value and the original image (both scaled and unscaled of each symbol in the file.

Version:

0.1

Author:

Stephen Wattam

See Also:

Letter

Constructor Summary

Constructors

Constructor and Description
Document(java.awt.image.BufferedImage p_image) A simple constructor to instantiate the image on which the document is to be based.

Method Summary

Methods

Modifier and Type	Method and Description
void	addLetter(Letter p_letter) Adds a letter to the list of letters.
void	clearLetters() Clears the document of letters.
java.awt.image.BufferedImage	getImage() Returns the image that this document is based on.
Letter[]	getLetters() Returns an array of all Letters contained within this document.
void	setImage(java.awt.image.BufferedImage p_image) Sets the image that this document is based on.

Methods inherited from class java.lang.Object

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

Constructor Detail

Document

public Document(java.awt.image.BufferedImage p_image)

A simple constructor to instantiate the image on which the document is to be based.

Parameters:

p_image - The image on which to base the new Document

Method Detail

setImage

public void setImage(java.awt.image.BufferedImage p_image)

Sets the image that this document is based on. Doing this will make the letters obselete, so also call clearLetters.

Parameters:

p_image - The image to base this Document on.

See Also:

clearLetters()

getImage

public java.awt.image.BufferedImage getImage()

Returns the image that this document is based on.

Returns:

The image on which this Document is based. This can be obselete, say, if it has been changed by sloppy assignment and differs from its component Symbols.

See Also:

setImage(BufferedImage)

getLetters

public Letter[] getLetters()

Returns an array of all Letters contained within this document.

Returns:

ALl letters of which this document comprises.

See Also:

Letter

addLetter

public void addLetter(Letter p_letter)

Adds a letter to the list of letters. This will merely append it, meaning that any in-order traversal of the array returned from getLetters can be made to return a nicely-ordered string.

Parameters:

p_letter - The letter to add to the Document

clearLetters

public void clearLetters()

Clears the document of letters. Can be useful when re-analysing documents using the OCRManager.

See Also:

OCRManager