Package digilib.io
Class ImageFileSet
java.lang.Object
digilib.io.ImageSet
digilib.io.ImageFileSet
- All Implemented Interfaces:
- DocuDirent,- Comparable<Object>
ImageSet using ImageFiles filled from an array of scaled Directories.
- Author:
- casties
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected Filethe (main) fileprotected static FileOps.FileClassthis is an image fileprotected FileMetathe FileMeta instanceprotected booleanis our metadata validprotected Stringthe file nameprotected DocuDirectorythe parent DocuDirectory
- 
Constructor SummaryConstructorsConstructorDescriptionImageFileSet(File file, FsDirectory[] scaleDirs) Constructor with a File and Directories.
- 
Method SummaryModifier and TypeMethodDescriptionvoidChecks metadata and sets resolution in resX and resY.intComparator using the file name.protected voidfill(FsDirectory[] scaleDirs, File fl) Fill the ImageSet with files from an array of base directories.getFile()Get the default File.getMeta()Returns the meta-data for this file(set).getName()The name of the file.Returns the parent Directory.booleanvoidreadMeta()Reads meta-data for this Fileset if there is any.voidSets the meta-data for this file(set).voidsetParent(DocuDirectory parent) Sets the parent Directory.Methods inherited from class digilib.io.ImageSetadd, append, get, get, getAspect, getBiggest, getBiggestPreferred, getHiresIterator, getLoresIterator, getNextBigger, getNextBigger, getNextBiggerPreferred, getNextSmaller, getNextSmaller, getNextSmallerPreferred, getResX, getResY, getSmallest, getSmallestPreferred, setAspect, size
- 
Field Details- 
fileClassthis is an image file
- 
filethe (main) file
- 
namethe file name
- 
metathe FileMeta instance
- 
metaCheckedprotected boolean metaCheckedis our metadata valid
- 
parentthe parent DocuDirectory
 
- 
- 
Constructor Details- 
ImageFileSetConstructor with a File and Directories.- Parameters:
- file- the File
- scaleDirs- the Directories
 
 
- 
- 
Method Details- 
getNameDescription copied from interface:DocuDirentThe 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:
- getNamein interface- DocuDirent
- Returns:
- the name
 
- 
getParentDescription copied from interface:DocuDirentReturns the parent Directory.- Specified by:
- getParentin interface- DocuDirent
- Returns:
- the DocuDirectory
 
- 
setParentDescription copied from interface:DocuDirentSets the parent Directory.- Specified by:
- setParentin interface- DocuDirent
- Parameters:
- parent- The parent to set
 
- 
isMetaCheckedpublic boolean isMetaChecked()
- 
compareToDescription copied from interface:DocuDirentComparator using the file name. Compares to a String (for binarySearch) or to another DocuDirent (for sort).- Specified by:
- compareToin interface- Comparable<Object>
- Specified by:
- compareToin interface- DocuDirent
- Parameters:
- arg0- the other Object
- See Also:
 
- 
getFileGet the default File.- Returns:
- the File
 
- 
fillFill the ImageSet with files from an array of base directories.- Parameters:
- scaleDirs- array of base directories
- fl- file (from first base dir)
 
- 
checkMetapublic void checkMeta()Checks metadata and sets resolution in resX and resY.- Specified by:
- checkMetain interface- DocuDirent
- Overrides:
- checkMetain class- ImageSet
 
- 
readMetapublic void readMeta()Description copied from interface:DocuDirentReads meta-data for this Fileset if there is any.- Specified by:
- readMetain interface- DocuDirent
 
- 
getMetaDescription copied from interface:DocuDirentReturns the meta-data for this file(set).- Specified by:
- getMetain interface- DocuDirent
- Returns:
- the FileMeta
 
- 
setMetaDescription copied from interface:DocuDirentSets the meta-data for this file(set).- Specified by:
- setMetain interface- DocuDirent
- Parameters:
- fileMeta- The fileMeta to set
 
 
-