DocuDirent (digilib 2.12.3 API)

All Superinterfaces:

Comparable<Object>

All Known Implementing Classes:

DocuDirentImpl, DocuImageSet, ImageFileSet, SVGFile, TextFile
```
public interface DocuDirent
extends Comparable<Object>
```
Interface for an object that represents the content of a DocuDirectory.

Author:

casties

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`checkMeta()`	Checks metadata and does something with it.
`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.

- Method Detail
  - getName
```
String getName()
```
    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).
    
    Returns:
    
    the name
  - getParent
```
DocuDirectory getParent()
```
    Returns the parent Directory.
    
    Returns:
    
    the DocuDirectory
  - setParent
```
void setParent(DocuDirectory parent)
```
    Sets the parent Directory.
    
    Parameters:
    
    parent - The parent to set
  - readMeta
```
void readMeta()
```
    Reads meta-data for this Fileset if there is any.
  - checkMeta
```
void checkMeta()
```
    Checks metadata and does something with it.
  - getMeta
```
FileMeta getMeta()
```
    Returns the meta-data for this file(set).
    
    Returns:
    
    the FileMeta
  - setMeta
```
void setMeta(FileMeta fileMeta)
```
    Sets the meta-data for this file(set).
    
    Parameters:
    
    fileMeta - The fileMeta to set
  - compareTo
```
int compareTo(Object arg0)
```
    Comparator using the file name. Compares to a String (for binarySearch) or to another DocuDirent (for sort).
    
    Specified by:
    
    compareTo in interface Comparable<Object>
    
    Parameters:
    
    arg0 - the other Object
    
    See Also:
    
    Comparable.compareTo(java.lang.Object)