org.daisy.zedval.engine
Class AudioFile

java.lang.Object
  extended byjava.io.File
      extended byorg.daisy.zedval.engine.ZedFile
          extended byorg.daisy.zedval.engine.ManifestFile
              extended byorg.daisy.zedval.engine.AudioFile
All Implemented Interfaces:
java.lang.Comparable, java.io.Serializable
Direct Known Subclasses:
Mp3File, WavFile, AacFile

public class AudioFile
extends ManifestFile

An AudioFile object represents a single DTB audio file

Author:
James Pritchett
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.daisy.zedval.engine.ManifestFile
MIME_JPEG, MIME_MP3, MIME_NCX, MIME_PACKAGE, MIME_PNG, MIME_RESOURCE, MIME_SMIL, MIME_SVG, MIME_TEXT, MIME_WAV, MIME_AAC
 
Fields inherited from class java.io.File
pathSeparator, pathSeparatorChar, separator, separatorChar
 
Constructor Summary
AudioFile(java.lang.String fullPath, java.lang.String id, java.lang.String mimeType)
           
 
Method Summary
 boolean doesMatchFormat()
          Is the file in the declared format?
 org.daisy.util.xml.SmilClock getDuration()
          Returns duration of the audio file
 void initialize()
          A do-nothing initialize for the generic AudioFile
 
Methods inherited from class org.daisy.zedval.engine.ManifestFile
getId, getMimeType, getPackage, setID, setMimeType, setPackage, toString
 
Methods inherited from class org.daisy.zedval.engine.ZedFile
getName
 
Methods inherited from class java.io.File
canRead, canWrite, compareTo, compareTo, createNewFile, createTempFile, createTempFile, delete, deleteOnExit, equals, exists, getAbsoluteFile, getAbsolutePath, getCanonicalFile, getCanonicalPath, getParent, getParentFile, getPath, hashCode, isAbsolute, isDirectory, isFile, isHidden, lastModified, length, list, list, listFiles, listFiles, listFiles, listRoots, mkdir, mkdirs, renameTo, setLastModified, setReadOnly, toURI, toURL
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AudioFile

public AudioFile(java.lang.String fullPath,
                 java.lang.String id,
                 java.lang.String mimeType)
Parameters:
id - id from package file manifest
fullPath - File path (relative to package file)
mimeType - File MIME type as given in package manifest
Method Detail

doesMatchFormat

public boolean doesMatchFormat()
Is the file in the declared format?

Returns:
true if so

getDuration

public org.daisy.util.xml.SmilClock getDuration()
Returns duration of the audio file

Returns:
duration of the file as SmilClock

initialize

public void initialize()
                throws ZedFileInitializationException
A do-nothing initialize for the generic AudioFile

Throws:
ZedFileInitializationException