edu.harvard.hul.ois.mets
Class FileGrp

java.lang.Object
  extended byedu.harvard.hul.ois.mets.helper.MetsElement
      extended byedu.harvard.hul.ois.mets.helper.MetsVElement
          extended byedu.harvard.hul.ois.mets.helper.MetsIDElement
              extended byedu.harvard.hul.ois.mets.FileGrp
All Implemented Interfaces:
MetsIdentifiable, MetsSerializable, MetsValidatable

public class FileGrp
extends MetsIDElement

This class encapsulates the <fileGrp> 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
FileGrp()
          Instantiate a new FileGrp object.
 
Method Summary
 java.util.Map getADMID()
          Return map of IDREFS of administrative metadata.
 java.lang.String getUSE()
          Return use flag for this fileGrp.
 java.util.Date getVERSDATE()
          Return version date/time of this fileGrp.
 void read(MetsReader r)
          De-serialize the content of the file into this element using the given reader.
static FileGrp reader(MetsReader r)
          Instantiate a FileGrp 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 setUSE(java.lang.String use)
          Set use flag for this fileGrp.
 void setVERSDATE(java.util.Date date)
          Set version date/time of this fileGrp.
 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, validateThis, validateThisIDREFs
 
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

FileGrp

public FileGrp()
Instantiate a new FileGrp object.

Method Detail

getADMID

public java.util.Map getADMID()
Return map of IDREFS of administrative metadata.

Returns:
Map

getUSE

public java.lang.String getUSE()
Return use flag for this fileGrp.

Returns:
Use

getVERSDATE

public java.util.Date getVERSDATE()
Return version date/time of this fileGrp.

Returns:
Date/time

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)

setUSE

public void setUSE(java.lang.String use)
Set use flag for this fileGrp.

Parameters:
use - Use flag

setVERSDATE

public void setVERSDATE(java.util.Date date)
Set version date/time of this fileGrp.

Parameters:
date - Date/time

reader

public static FileGrp reader(MetsReader r)
                      throws MetsException
Instantiate a FileGrp object de-serialized from the input stream.

Parameters:
r - Reader
Returns:
FileGrp 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