Package digilib.io

Class DocuImageSet

java.lang.Object

digilib.io.ImageSet

digilib.io.DocuImageSet

All Implemented Interfaces:

DocuDirent, Comparable<Object>

public class DocuImageSet
extends ImageSet
implements DocuDirent

ImageSet that is also a DocuDirent that can be put in a DocuDirectory.

Author:

casties

Field Summary

Fields

Modifier and Type	Field	Description
protected FileMeta	meta	the FileMeta instance
protected boolean	metaChecked	is our metadata valid
protected String	name	the "file" name
protected DocuDirectory	parent	the parent DocuDirectory

Fields inherited from class digilib.io.ImageSet

aspect, list, resX, resY

Constructor Summary

Constructors

Constructor	Description
DocuImageSet(String name)

Method Summary

Modifier and Type	Method	Description
int	compareTo(Object arg0)	Comparator using the file name.
FileMeta	getMeta()	Returns the meta-data for this file(set).
String	getName()	The name of the file.
DocuDirectory	getParent()	Returns the parent Directory.
void	readMeta()	Reads meta-data for this Fileset if there is any.
void	setMeta(FileMeta fileMeta)	Sets the meta-data for this file(set).
void	setParent(DocuDirectory parent)	Sets the parent Directory.

Methods inherited from class digilib.io.ImageSet

add, append, checkMeta, get, get, getAspect, getBiggest, getBiggestPreferred, getHiresIterator, getLoresIterator, getNextBigger, getNextBigger, getNextBiggerPreferred, getNextSmaller, getNextSmaller, getNextSmallerPreferred, getResX, getResY, getSmallest, getSmallestPreferred, setAspect, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface digilib.io.DocuDirent

checkMeta

Field Detail

name

protected String name

the "file" name

meta

protected FileMeta meta

the FileMeta instance

metaChecked

protected boolean metaChecked

is our metadata valid

parent

protected DocuDirectory parent

the parent DocuDirectory

Constructor Detail

DocuImageSet

public DocuImageSet(String name)

Parameters:

name - the name

Method Detail

getName

public String getName()

Description copied from interface: DocuDirent

The name of the file. If this is a Fileset, the method returns the name of the default file (for image filesets the highest resolution file).

Specified by:

getName in interface DocuDirent

Returns:

the name

getParent

public DocuDirectory getParent()

Description copied from interface: DocuDirent

Returns the parent Directory.

Specified by:

getParent in interface DocuDirent

Returns:

the DocuDirectory

setParent

public void setParent(DocuDirectory parent)

Description copied from interface: DocuDirent

Sets the parent Directory.

Specified by:

setParent in interface DocuDirent

Parameters:

parent - The parent to set

getMeta

public FileMeta getMeta()

Description copied from interface: DocuDirent

Returns the meta-data for this file(set).

Specified by:

getMeta in interface DocuDirent

Returns:

the FileMeta

setMeta

public void setMeta(FileMeta fileMeta)

Description copied from interface: DocuDirent

Sets the meta-data for this file(set).

Specified by:

setMeta in interface DocuDirent

Parameters:

fileMeta - The fileMeta to set

readMeta

public void readMeta()

Description copied from interface: DocuDirent

Reads meta-data for this Fileset if there is any.

Specified by:

readMeta in interface DocuDirent

compareTo

public int compareTo(Object arg0)

Description copied from interface: DocuDirent

Comparator using the file name. Compares to a String (for binarySearch) or to another DocuDirent (for sort).

Specified by:

compareTo in interface Comparable<Object>

Specified by:

compareTo in interface DocuDirent

Parameters:

arg0 - the other Object

See Also:

Comparable.compareTo(java.lang.Object)