edu.indiana.dlib.metsnav.mets.v1_5
Class MetsHdr

java.lang.Object
  edu.indiana.dlib.metsnav.mets.v1_5.MetsHdr

All Implemented Interfaces:

Serializable

public class MetsHdr
extends Object
implements Serializable

metsHdr: METS Header. Like a TEI Header, the METS Header element records metadata about the METS document itself (not the digital library object that the METS document encodes). It has two possible subsidiary elements, agent (document agent) and altRecordID (alternative Record ID)..

See Also:

Serialized Form

Constructor Summary

MetsHdr()

Method Summary

void	addAgent(Agent vAgent) Method addAgent
void	addAgent(int index, Agent vAgent) Method addAgent
void	addAltRecordID(AltRecordID vAltRecordID) Method addAltRecordID
void	addAltRecordID(int index, AltRecordID vAltRecordID) Method addAltRecordID
void	clearAgent() Method clearAgent
void	clearAltRecordID() Method clearAltRecordID
Enumeration	enumerateAgent() Method enumerateAgent
Enumeration	enumerateAltRecordID() Method enumerateAltRecordID
Agent[]	getAgent() Method getAgent
Agent	getAgent(int index) Method getAgent
int	getAgentCount() Method getAgentCount
AltRecordID[]	getAltRecordID() Method getAltRecordID
AltRecordID	getAltRecordID(int index) Method getAltRecordID
int	getAltRecordIDCount() Method getAltRecordIDCount
Date	getCREATEDATE() Returns the value of field 'CREATEDATE'.
String	getID() Returns the value of field 'ID'.
Date	getLASTMODDATE() Returns the value of field 'LASTMODDATE'.
String	getRECORDSTATUS() Returns the value of field 'RECORDSTATUS'.
boolean	isValid() Method isValid
void	marshal(ContentHandler handler) Method marshal
void	marshal(Writer out) Method marshal
boolean	removeAgent(Agent vAgent) Method removeAgent
boolean	removeAltRecordID(AltRecordID vAltRecordID) Method removeAltRecordID
void	setAgent(Agent[] agentArray) Method setAgent
void	setAgent(int index, Agent vAgent) Method setAgent
void	setAltRecordID(AltRecordID[] altRecordIDArray) Method setAltRecordID
void	setAltRecordID(int index, AltRecordID vAltRecordID) Method setAltRecordID
void	setCREATEDATE(Date CREATEDATE) Sets the value of field 'CREATEDATE'.
void	setID(String ID) Sets the value of field 'ID'.
void	setLASTMODDATE(Date LASTMODDATE) Sets the value of field 'LASTMODDATE'.
void	setRECORDSTATUS(String RECORDSTATUS) Sets the value of field 'RECORDSTATUS'.
static Object	unmarshal(Reader reader) Method unmarshal
void	validate() Method validate

Methods inherited from class java.lang.Object

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

Constructor Detail

MetsHdr

public MetsHdr()

Method Detail

addAgent

public void addAgent(Agent vAgent)
              throws IndexOutOfBoundsException

Method addAgent

Parameters:

vAgent -

Throws:

IndexOutOfBoundsException

addAgent

public void addAgent(int index,
                     Agent vAgent)
              throws IndexOutOfBoundsException

Method addAgent

Parameters:

index -

vAgent -

Throws:

IndexOutOfBoundsException

addAltRecordID

public void addAltRecordID(AltRecordID vAltRecordID)
                    throws IndexOutOfBoundsException

Method addAltRecordID

Parameters:

vAltRecordID -

Throws:

IndexOutOfBoundsException

addAltRecordID

public void addAltRecordID(int index,
                           AltRecordID vAltRecordID)
                    throws IndexOutOfBoundsException

Method addAltRecordID

Parameters:

index -

vAltRecordID -

Throws:

IndexOutOfBoundsException

clearAgent

public void clearAgent()

Method clearAgent

clearAltRecordID

public void clearAltRecordID()

Method clearAltRecordID

enumerateAgent

public Enumeration enumerateAgent()

Method enumerateAgent

Returns:

Enumeration

enumerateAltRecordID

public Enumeration enumerateAltRecordID()

Method enumerateAltRecordID

Returns:

Enumeration

getAgent

public Agent getAgent(int index)
               throws IndexOutOfBoundsException

Method getAgent

Parameters:

index -

Returns:

Agent

Throws:

IndexOutOfBoundsException

getAgent

public Agent[] getAgent()

Method getAgent

Returns:

Agent

getAgentCount

public int getAgentCount()

Method getAgentCount

Returns:

int

getAltRecordID

public AltRecordID getAltRecordID(int index)
                           throws IndexOutOfBoundsException

Method getAltRecordID

Parameters:

index -

Returns:

AltRecordID

Throws:

IndexOutOfBoundsException

getAltRecordID

public AltRecordID[] getAltRecordID()

Method getAltRecordID

Returns:

AltRecordID

getAltRecordIDCount

public int getAltRecordIDCount()

Method getAltRecordIDCount

Returns:

int

getCREATEDATE

public Date getCREATEDATE()

Returns the value of field 'CREATEDATE'. The field 'CREATEDATE' has the following description: CREATEDATE: an optional dateTime specifying when the METS document was created.

Returns:

Date

getID

public String getID()

Returns the value of field 'ID'. The field 'ID' has the following description: ID: an optional XML ID value

Returns:

String

getLASTMODDATE

public Date getLASTMODDATE()

Returns the value of field 'LASTMODDATE'. The field 'LASTMODDATE' has the following description: LASTMODDATE: an optional dateTime specifying when the METS document was last modified;

Returns:

Date

getRECORDSTATUS

public String getRECORDSTATUS()

Returns the value of field 'RECORDSTATUS'. The field 'RECORDSTATUS' has the following description: RECORDSTATUS: an optional string indicating the status of the METS document, to be used mainly for internal processing purposes.

Returns:

String

isValid

public boolean isValid()

Method isValid

Returns:

boolean

marshal

public void marshal(Writer out)
             throws MarshalException,
                    ValidationException

Method marshal

Parameters:

out -

Throws:

MarshalException

ValidationException

marshal

public void marshal(ContentHandler handler)
             throws IOException,
                    MarshalException,
                    ValidationException

Method marshal

Parameters:

handler -

Throws:

IOException

MarshalException

ValidationException

removeAgent

public boolean removeAgent(Agent vAgent)

Method removeAgent

Parameters:

vAgent -

Returns:

boolean

removeAltRecordID

public boolean removeAltRecordID(AltRecordID vAltRecordID)

Method removeAltRecordID

Parameters:

vAltRecordID -

Returns:

boolean

setAgent

public void setAgent(int index,
                     Agent vAgent)
              throws IndexOutOfBoundsException

Method setAgent

Parameters:

index -

vAgent -

Throws:

IndexOutOfBoundsException

setAgent

public void setAgent(Agent[] agentArray)

Method setAgent

Parameters:

agentArray -

setAltRecordID

public void setAltRecordID(int index,
                           AltRecordID vAltRecordID)
                    throws IndexOutOfBoundsException

Method setAltRecordID

Parameters:

index -

vAltRecordID -

Throws:

IndexOutOfBoundsException

setAltRecordID

public void setAltRecordID(AltRecordID[] altRecordIDArray)

Method setAltRecordID

Parameters:

altRecordIDArray -

setCREATEDATE

public void setCREATEDATE(Date CREATEDATE)

Sets the value of field 'CREATEDATE'. The field 'CREATEDATE' has the following description: CREATEDATE: an optional dateTime specifying when the METS document was created.

Parameters:

CREATEDATE - the value of field 'CREATEDATE'.

setID

public void setID(String ID)

Sets the value of field 'ID'. The field 'ID' has the following description: ID: an optional XML ID value

Parameters:

ID - the value of field 'ID'.

setLASTMODDATE

public void setLASTMODDATE(Date LASTMODDATE)

Sets the value of field 'LASTMODDATE'. The field 'LASTMODDATE' has the following description: LASTMODDATE: an optional dateTime specifying when the METS document was last modified;

Parameters:

LASTMODDATE - the value of field 'LASTMODDATE'.

setRECORDSTATUS

public void setRECORDSTATUS(String RECORDSTATUS)

Sets the value of field 'RECORDSTATUS'. The field 'RECORDSTATUS' has the following description: RECORDSTATUS: an optional string indicating the status of the METS document, to be used mainly for internal processing purposes.

Parameters:

RECORDSTATUS - the value of field 'RECORDSTATUS'.

unmarshal

public static Object unmarshal(Reader reader)
                        throws MarshalException,
                               ValidationException

Method unmarshal

Parameters:

reader -

Returns:

Object

Throws:

MarshalException

ValidationException

validate

public void validate()
              throws ValidationException

Method validate

Throws:

ValidationException