edu.harvard.hul.ois.mets
Class File

java.lang.Object
  edu.harvard.hul.ois.mets.helper.MetsElement
      edu.harvard.hul.ois.mets.helper.MetsVElement
          edu.harvard.hul.ois.mets.helper.MetsIDElement
              edu.harvard.hul.ois.mets.File

All Implemented Interfaces:

MetsIdentifiable, MetsSerializable, MetsValidatable

public class File

extends MetsIDElement

This class encapsulates the <file> element. See <http://www.loc.gov/standards/mets/>.

Field Summary

Fields inherited from class edu.harvard.hul.ois.mets.helper.MetsIDElement

_ID

Fields inherited from class edu.harvard.hul.ois.mets.helper.MetsVElement

_valid

Fields inherited from class edu.harvard.hul.ois.mets.helper.MetsElement

_attrs, _content, _localName, _namespace, _qName, _schema

Constructor Summary

File()
Instantiate a new File object.

Method Summary

java.util.Map	getADMID() Return map IDREFS to administrative metadata.
java.lang.String	getCHECKSUM() Return file checksum.
Checksumtype	getCHECKSUMTYPE() Return file checksum type.
java.util.Date	getCREATED() Return file creation date/time.
java.util.Map	getDMDID() Return map IDREFS to descriptive metadata.
java.lang.String	getGROUPID() Return file group ID.
java.lang.String	getMIMETYPE() Return file MIME type.
java.lang.String	getOWNERID() Return file owner-specific ID.
int	getSEQ() Return file sequence number in this fileGrp.
long	getSIZE() Return file size in bytes.
java.lang.String	getUSE() Return use flag for this fileGrp.
void	read(MetsReader r) De-serialize the content of the file into this element using the given reader.
static File	reader(MetsReader r) Instantiate a File object de-serialized from the input stream.
void	setADMID(java.lang.String ADMID) Set ADMID of AmdSec element.
void	setADMID(java.lang.String ADMID, MetsIDElement elem) Set ADMID of AmdSec element, with referenced element.
void	setCHECKSUM(java.lang.String checksum) Set file checksum.
void	setCHECKSUMTYPE(Checksumtype type) Set file checksum type.
void	setCREATED(java.util.Date date) Set file creation date/time.
void	setDMDID(java.lang.String DMDID) Set DMDID of DmdSec element.
void	setDMDID(java.lang.String DMDID, DmdSec elem) Set DMDID of DmdSec element, with referenced element.
void	setGROUPID(java.lang.String id) Set file group ID.
void	setMIMETYPE(java.lang.String mime) Set file MIME type.
void	setOWNERID(java.lang.String id) Set file owner-specific ID.
void	setSEQ(int seq) Set file sequence order in this fileGrp.
void	setSIZE(long size) Set file size in bytes.
void	setUSE(java.lang.String use) Set use flag for this fileGrp.
void	validateThis(MetsValidator v) Validate this element using the given validator.
void	validateThisIDREFs(MetsValidator v) Validate ID/IDREF consistency with the given validator.
void	write(MetsWriter w) Serialize the content of this element using the given writer.

Methods inherited from class edu.harvard.hul.ois.mets.helper.MetsIDElement

getID, setID

Methods inherited from class edu.harvard.hul.ois.mets.helper.MetsVElement

isValid, validate, validateIDREFs

Methods inherited from class edu.harvard.hul.ois.mets.helper.MetsElement

getContent, getLocalName, getNamespace, getQName, getSchemas, init, setSchema, setSchema, writeSchemas

Methods inherited from class java.lang.Object

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

Constructor Detail

File

public File()

Instantiate a new File object.

Method Detail

getADMID

public java.util.Map getADMID()

Return map IDREFS to administrative metadata.

Returns:

Map

getCHECKSUM

public java.lang.String getCHECKSUM()

Return file checksum.

Returns:

Checksum

getCHECKSUMTYPE

public Checksumtype getCHECKSUMTYPE()

Return file checksum type.

Returns:

Checksum type

getCREATED

public java.util.Date getCREATED()

Return file creation date/time.

Returns:

Date/time

getDMDID

public java.util.Map getDMDID()

Return map IDREFS to descriptive metadata.

Returns:

Map

getGROUPID

public java.lang.String getGROUPID()

Return file group ID.

Returns:

Group ID

getMIMETYPE

public java.lang.String getMIMETYPE()

Return file MIME type.

Returns:

MIME type

getOWNERID

public java.lang.String getOWNERID()

Return file owner-specific ID.

Returns:

Owner ID

getSEQ

public int getSEQ()
           throws MetsException

Return file sequence number in this fileGrp.

Returns:

Sequence number

Throws:

MetsException - If SEQ has not been set

getSIZE

public long getSIZE()
             throws MetsException

Return file size in bytes.

Returns:

File size

Throws:

MetsException - If SIZE has not been set

getUSE

public java.lang.String getUSE()

Return use flag for this fileGrp.

Returns:

Use

setADMID

public void setADMID(java.lang.String ADMID)

Set ADMID of AmdSec element.

Parameters:

ADMID - Element IDREF

setADMID

public void setADMID(java.lang.String ADMID,
                     MetsIDElement elem)

Set ADMID of AmdSec element, with referenced element.

Parameters:

ADMID - Element IDREF

elem - Element (or NULL)

setCHECKSUM

public void setCHECKSUM(java.lang.String checksum)

Set file checksum.

Parameters:

checksum - Checksum

setCHECKSUMTYPE

public void setCHECKSUMTYPE(Checksumtype type)

Set file checksum type.

Parameters:

type - Checksum type

setCREATED

public void setCREATED(java.util.Date date)

Set file creation date/time.

Parameters:

date - Creation date/time

setDMDID

public void setDMDID(java.lang.String DMDID)

Set DMDID of DmdSec element.

Parameters:

DMDID - Element IDREF

setDMDID

public void setDMDID(java.lang.String DMDID,
                     DmdSec elem)

Set DMDID of DmdSec element, with referenced element.

Parameters:

DMDID - Element IDREF

elem - Element (or NULL)

setGROUPID

public void setGROUPID(java.lang.String id)

Set file group ID.

Parameters:

id - Group ID

setMIMETYPE

public void setMIMETYPE(java.lang.String mime)

Set file MIME type.

Parameters:

mime - MIME type

setOWNERID

public void setOWNERID(java.lang.String id)

Set file owner-specific ID.

Parameters:

id - Owner ID

setSEQ

public void setSEQ(int seq)

Set file sequence order in this fileGrp.

Parameters:

seq - Sequence order

setSIZE

public void setSIZE(long size)

Set file size in bytes.

Parameters:

size - File size

setUSE

public void setUSE(java.lang.String use)

Set use flag for this fileGrp.

Parameters:

use - Use flag

reader

public static File reader(MetsReader r)
                   throws MetsException

Instantiate a File object de-serialized from the input stream.

Parameters:

r - Reader

Returns:

File object

Throws:

MetsException - De-serializing exception

read

public void read(MetsReader r)
          throws MetsException

De-serialize the content of the file into this element using the given reader.

Specified by:

read in interface MetsSerializable

Specified by:

read in class MetsElement

Parameters:

r - Reader

Throws:

MetsException

write

public void write(MetsWriter w)
           throws MetsException

Serialize the content of this element using the given writer.

Specified by:

write in interface MetsSerializable

Specified by:

write in class MetsElement

Parameters:

w - Writer

Throws:

MetsException

validateThis

public void validateThis(MetsValidator v)
                  throws MetsException

Validate this element using the given validator.

Specified by:

validateThis in interface MetsValidatable

Overrides:

validateThis in class MetsVElement

Parameters:

v - Validator

Throws:

MetsException - Validation exception

validateThisIDREFs

public void validateThisIDREFs(MetsValidator v)
                        throws MetsException

Validate ID/IDREF consistency with the given validator.

Overrides:

validateThisIDREFs in class MetsVElement

Parameters:

v - Validator

Throws:

MetsException - Validation exception