Document
Class ImageID

java.lang.Object
  Document.ImageID

All Implemented Interfaces:

java.lang.Comparable<ImageID>

Direct Known Subclasses:

ImageIDnumerical

public abstract class ImageID
extends java.lang.Object
implements java.lang.Comparable<ImageID>

Abstract class representing the ID of an image/region.

Constructor Summary

ImageID()

Method Summary

abstract int	compareTo(ImageID id) Compares this object with the specified object for order.
boolean	equals(ImageID id) Compares this ID with the specified ID for equivalence.
boolean	equals(java.lang.Object o) Compares this object with the specified object for equivalence.
int	hashCode() Returns a hash code value for this object.
boolean	isErrorDB() Check for DB correctness of this object.
boolean	isErrorExtract() Check for validity in the feature extraction of this object.
boolean	isErrorFile() Check for correctness of the file of this object.
boolean	isErrorGeneric() Check for correctness of this object.
boolean	isErrorID() Check for uniqueness of this object.
boolean	isErrorNoImageFile() Check for correctness of the file of this object.
boolean	isErrorPath() Check for correctness of the file path of this object.
boolean	isErrorStream() Check for correctness of the read stream for this object.
boolean	isErrorURL() Check for correctness of the URL of this object.
boolean	isExtrOK() Check for correctness of this object.
boolean	isValid() Check for validity of this object.
abstract int	size() The number of elements in the ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageID

public ImageID()

Method Detail

size

public abstract int size()

The number of elements in the ID.

Returns:

Number of elements.

equals

public boolean equals(java.lang.Object o)

Compares this object with the specified object for equivalence.

Overrides:

equals in class java.lang.Object

Parameters:

o - Object to be compared.

Returns:

true if this object is the same as the argument; false otherwise.

equals

public boolean equals(ImageID id)

Compares this ID with the specified ID for equivalence.

Parameters:

id - ID to be compared.

Returns:

true if this ID is the same as the argument; false otherwise.

compareTo

public abstract int compareTo(ImageID id)

Compares this object with the specified object for order.

Specified by:

compareTo in interface java.lang.Comparable<ImageID>

Parameters:

id - ID to be compared.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

isValid

public boolean isValid()

Check for validity of this object.

Returns:

true if this object is valid; false otherwise (it represents an error).

isExtrOK

public boolean isExtrOK()

Check for correctness of this object.

Returns:

true if this object is correct; false otherwise (it represents an error during extraction).

isErrorDB

public boolean isErrorDB()

Check for DB correctness of this object.

Returns:

false if this object is correct; true otherwise (it represents an error in the DB).

isErrorURL

public boolean isErrorURL()

Check for correctness of the URL of this object.

Returns:

false if this object is correct; true otherwise (it represents an error in the image URL).

isErrorFile

public boolean isErrorFile()

Check for correctness of the file of this object.

Returns:

false if this object is correct; true otherwise (it represents an error in the image file).

isErrorID

public boolean isErrorID()

Check for uniqueness of this object.

Returns:

false if this object is correct; true otherwise (it means another object with the same ID exists in the DB).

isErrorExtract

public boolean isErrorExtract()

Check for validity in the feature extraction of this object.

Returns:

false if this object is correct; true otherwise (it represents an error during extraction).

isErrorPath

public boolean isErrorPath()

Check for correctness of the file path of this object.

Returns:

false if this object is correct; true otherwise (it represents an error in the image pathfile).

isErrorStream

public boolean isErrorStream()

Check for correctness of the read stream for this object.

Returns:

false if this object is correct; true otherwise (it represents an error in the read stream).

isErrorGeneric

public boolean isErrorGeneric()

Check for correctness of this object.

Returns:

false if this object is correct; true otherwise (it represents a generic error).

isErrorNoImageFile

public boolean isErrorNoImageFile()

Check for correctness of the file of this object.

Returns:

false if this object is correct; true otherwise (it means this is not an image file).

hashCode

public int hashCode()

Returns a hash code value for this object.

Overrides:

hashCode in class java.lang.Object

Returns:

A hash code value for this object.