edu.harvard.hul.ois.mets
Class Fptr

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.Fptr

All Implemented Interfaces:

MetsIdentifiable, MetsSerializable, MetsValidatable

public class Fptr

extends MetsIDElement

This class encapsulates the <fptr> 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

Fptr()
Instantiate a new <fptr> object.

Method Summary

java.util.List	getCONTENTIDS() Return list of CONTENTIDS.
java.util.Map	getFILEID() Return map of IDREF to File.
void	read(MetsReader r) De-serialize the content of the file into this element using the given reader.
static Fptr	reader(MetsReader r) Instantiate a Fptr object de-serialized from the input stream.
void	setCONTENTIDS(java.lang.String CONTENTIDS) Set CONTENTIDS.
void	setFILEID(java.lang.String FILEID) Set IDREF of File.
void	setFILEID(java.lang.String FILEID, File file) Set IDREF of File, with referenced element.
void	validateThisIDREFs(MetsValidator v) Validate ID/IDREF consistency using 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, validateThis

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

Fptr

public Fptr()

Instantiate a new <fptr> object.

Method Detail

getCONTENTIDS

public java.util.List getCONTENTIDS()

Return list of CONTENTIDS.

Returns:

List

getFILEID

public java.util.Map getFILEID()

Return map of IDREF to File.

Returns:

Map

setCONTENTIDS

public void setCONTENTIDS(java.lang.String CONTENTIDS)

Set CONTENTIDS. Note: Currently there is no encoding/decoding being performed on the URIs. They are assummed to already be in appropriate form.

Parameters:

CONTENTIDS -

setFILEID

public void setFILEID(java.lang.String FILEID)

Set IDREF of File.

Parameters:

FILEID - File IDREF

setFILEID

public void setFILEID(java.lang.String FILEID,
                      File file)

Set IDREF of File, with referenced element. The map is clear'ed first to ensure a single ID/IDREF pair.

Parameters:

FILEID - File IDREF

file - File element (or NULL)

reader

public static Fptr reader(MetsReader r)
                   throws MetsException

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

Parameters:

r - Reader

Returns:

Fptr 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

validateThisIDREFs

public void validateThisIDREFs(MetsValidator v)
                        throws MetsException

Validate ID/IDREF consistency using the given validator.

Overrides:

validateThisIDREFs in class MetsVElement

Parameters:

v - Validator

Throws:

MetsException - Validation exception