edu.harvard.hul.ois.mets
Class StructMap

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

All Implemented Interfaces:

MetsIdentifiable, MetsSerializable, MetsValidatable

public class StructMap

extends MetsIDElement

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

StructMap()
Instantiate a new StructMap object.

Method Summary

java.lang.String	getLABEL() Return descriptive label.
java.lang.String	getTYPE() Return map type
void	read(MetsReader r) De-serialize the content of the file into this element using the given reader.
static StructMap	reader(MetsReader r) Instantiate a StructMap object de-serialized from the input stream.
void	setLABEL(java.lang.String LABEL) Set descriptive label.
void	setTYPE(java.lang.String TYPE) Set map type.
void	validateThis(MetsValidator v) Validate this element 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, 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

StructMap

public StructMap()

Instantiate a new StructMap object.

Method Detail

getLABEL

public java.lang.String getLABEL()

Return descriptive label.

Returns:

Label

getTYPE

public java.lang.String getTYPE()

Return map type

Returns:

Map type

setLABEL

public void setLABEL(java.lang.String LABEL)

Set descriptive label.

Parameters:

LABEL - Label

setTYPE

public void setTYPE(java.lang.String TYPE)

Set map type.

Parameters:

TYPE - Map type

reader

public static StructMap reader(MetsReader r)
                        throws MetsException

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

Parameters:

r - Reader

Returns:

StructMap 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