edu.harvard.hul.ois.mets
Class Area

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

All Implemented Interfaces:

MetsIdentifiable, MetsSerializable, MetsValidatable

public class Area

extends MetsIDElement

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

Area()
Instantiate a new Area object.

Method Summary

java.util.Map	getADMID() Return map of IDREFS to administrative metadata.
java.lang.String	getBEGIN() Return beginning location.
Betype	getBETYPE() Return area being/end type.
java.util.List	getCONTENTIDS() Return list of CONTENTIDS.
java.lang.String	getCOORDS() Return area coordinates.
java.lang.String	getEND() Return ending location.
java.lang.String	getEXTENT() Return area extent
Exttype	getEXTTYPE() Return area extent type.
java.util.Map	getFILEID() Return map of IDREF of file.
Shape	getSHAPE() Return area shape.
void	read(MetsReader r) De-serialize the content of the file into this element using the given reader.
static Area	reader(MetsReader r) Instantiate a Area 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 ADMIND of AmdSec element, with referenced element.
void	setBEGIN(java.lang.String BEGIN) Set area beginning location
void	setBETYPE(Betype BETYPE) Set area begin/end type.
void	setCONTENTIDS(java.lang.String CONTENTIDS) Set CONTENTIDS.
void	setCOORDS(java.lang.String COORDS) Set area coordinates.
void	setEND(java.lang.String END) Set area ending location
void	setEXTENT(java.lang.String EXTENT) Set area extent
void	setEXTTYPE(Exttype EXTTYPE) Set area extent type.
void	setFILEID(java.lang.String FILEID) Set FILEID of File.
void	setFILEID(java.lang.String FILEID, File file) Set FILEID of File, with referenced element.
void	setSHAPE(Shape SHAPE) Set area shape.
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

Area

public Area()

Instantiate a new Area object.

Method Detail

getADMID

public java.util.Map getADMID()

Return map of IDREFS to administrative metadata.

Returns:

Map

getBEGIN

public java.lang.String getBEGIN()

Return beginning location.

Returns:

Beginning location

getBETYPE

public Betype getBETYPE()

Return area being/end type.

Returns:

Begin/end type

getCONTENTIDS

public java.util.List getCONTENTIDS()

Return list of CONTENTIDS.

Returns:

List

getCOORDS

public java.lang.String getCOORDS()

Return area coordinates.

Returns:

Coordinates

getEND

public java.lang.String getEND()

Return ending location.

Returns:

Ending location

getEXTENT

public java.lang.String getEXTENT()

Return area extent

Returns:

Extant

getEXTTYPE

public Exttype getEXTTYPE()

Return area extent type.

Returns:

Extent type

getFILEID

public java.util.Map getFILEID()

Return map of IDREF of file.

Returns:

Map

getSHAPE

public Shape getSHAPE()

Return area shape.

Returns:

Area shape

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 ADMIND of AmdSec element, with referenced element.

Parameters:

ADMID - Element IDREF

elem - Element (or NULL)

setBEGIN

public void setBEGIN(java.lang.String BEGIN)

Set area beginning location

Parameters:

BEGIN - Beginning location

setBETYPE

public void setBETYPE(Betype BETYPE)

Set area begin/end type.

Parameters:

BETYPE - Begin/end type

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 -

setCOORDS

public void setCOORDS(java.lang.String COORDS)

Set area coordinates.

Parameters:

COORDS - Area coordinates

setEND

public void setEND(java.lang.String END)

Set area ending location

Parameters:

END - Ending location

setEXTENT

public void setEXTENT(java.lang.String EXTENT)

Set area extent

Parameters:

EXTENT - Area extent

setEXTTYPE

public void setEXTTYPE(Exttype EXTTYPE)

Set area extent type.

Parameters:

EXTTYPE - Extent type

setFILEID

public void setFILEID(java.lang.String FILEID)

Set FILEID of File.

Parameters:

FILEID - File IDREF

setFILEID

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

Set FILEID 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)

setSHAPE

public void setSHAPE(Shape SHAPE)

Set area shape.

Parameters:

SHAPE - Area shape

reader

public static Area reader(MetsReader r)
                   throws MetsException

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

Parameters:

r - Reader

Returns:

Area 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