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

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

All Implemented Interfaces:

Serializable

public class Mptr
extends Object
implements Serializable

mptr: METS Pointer. The mptr element allows a div to be associated with a separate METS document containing the content corresponding with that div, rather than pointing to an internal file or file group. A typical instance of this would be the case of a METS document for a journal run, with a div elements for each individual journal issue. The div elements for the issues might point to separate METS documents for each issue, rather than having files and file groups for every issue encoded in one document. NOTE: mptr is an empty element. The location of the resource pointed to MUST be stored in the xlink:href attribute.

See Also:

Serialized Form

Constructor Summary

Mptr()

Method Summary

void	addCONTENTIDS(int index, String vCONTENTIDS) Method addCONTENTIDS
void	addCONTENTIDS(String vCONTENTIDS) Method addCONTENTIDS
void	clearCONTENTIDS() Method clearCONTENTIDS
Enumeration	enumerateCONTENTIDS() Method enumerateCONTENTIDS
Object	getActuate() Returns the value of field 'actuate'.
Object	getArcrole() Returns the value of field 'arcrole'.
String[]	getCONTENTIDS() Method getCONTENTIDS
String	getCONTENTIDS(int index) Method getCONTENTIDS
int	getCONTENTIDSCount() Method getCONTENTIDSCount
Object	getHref() Returns the value of field 'href'.
String	getID() Returns the value of field 'ID'.
ObjectTypeLOCTYPEType	getLOCTYPE() Returns the value of field 'LOCTYPE'.
String	getOTHERLOCTYPE() Returns the value of field 'OTHERLOCTYPE'.
Object	getRole() Returns the value of field 'role'.
Object	getShow() Returns the value of field 'show'.
Object	getTitle() Returns the value of field 'title'.
String	getType() Returns the value of field 'type'.
boolean	isValid() Method isValid
void	marshal(ContentHandler handler) Method marshal
void	marshal(Writer out) Method marshal
boolean	removeCONTENTIDS(String vCONTENTIDS) Method removeCONTENTIDS
void	setActuate(Object actuate) Sets the value of field 'actuate'.
void	setArcrole(Object arcrole) Sets the value of field 'arcrole'.
void	setCONTENTIDS(int index, String vCONTENTIDS) Method setCONTENTIDS
void	setCONTENTIDS(String[] CONTENTIDSArray) Method setCONTENTIDS
void	setHref(Object href) Sets the value of field 'href'.
void	setID(String ID) Sets the value of field 'ID'.
void	setLOCTYPE(ObjectTypeLOCTYPEType LOCTYPE) Sets the value of field 'LOCTYPE'.
void	setOTHERLOCTYPE(String OTHERLOCTYPE) Sets the value of field 'OTHERLOCTYPE'.
void	setRole(Object role) Sets the value of field 'role'.
void	setShow(Object show) Sets the value of field 'show'.
void	setTitle(Object title) Sets the value of field 'title'.
void	setType(String type) Sets the value of field 'type'.
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

Mptr

public Mptr()

Method Detail

addCONTENTIDS

public void addCONTENTIDS(String vCONTENTIDS)
                   throws IndexOutOfBoundsException

Method addCONTENTIDS

Parameters:

vCONTENTIDS -

Throws:

IndexOutOfBoundsException

addCONTENTIDS

public void addCONTENTIDS(int index,
                          String vCONTENTIDS)
                   throws IndexOutOfBoundsException

Method addCONTENTIDS

Parameters:

index -

vCONTENTIDS -

Throws:

IndexOutOfBoundsException

clearCONTENTIDS

public void clearCONTENTIDS()

Method clearCONTENTIDS

enumerateCONTENTIDS

public Enumeration enumerateCONTENTIDS()

Method enumerateCONTENTIDS

Returns:

Enumeration

getActuate

public Object getActuate()

Returns the value of field 'actuate'.

Returns:

Object

getArcrole

public Object getArcrole()

Returns the value of field 'arcrole'.

Returns:

Object

getCONTENTIDS

public String getCONTENTIDS(int index)
                     throws IndexOutOfBoundsException

Method getCONTENTIDS

Parameters:

index -

Returns:

String

Throws:

IndexOutOfBoundsException

getCONTENTIDS

public String[] getCONTENTIDS()

Method getCONTENTIDS

Returns:

String

getCONTENTIDSCount

public int getCONTENTIDSCount()

Method getCONTENTIDSCount

Returns:

int

getHref

public Object getHref()

Returns the value of field 'href'.

Returns:

Object

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

getLOCTYPE

public ObjectTypeLOCTYPEType getLOCTYPE()

Returns the value of field 'LOCTYPE'. The field 'LOCTYPE' has the following description: LOCTYPE: Location Type the type of locator used to reference a file. It must have one of the following values: URN: Uniform Resource Name URL: Uniform Resource Locator PURL: Persistent URL HANDLE: a CNRI Handle DOI: A Digital Object Identifier OTHER: a form of locator not specified above.

Returns:

ObjectTypeLOCTYPEType

getOTHERLOCTYPE

public String getOTHERLOCTYPE()

Returns the value of field 'OTHERLOCTYPE'. The field 'OTHERLOCTYPE' has the following description: OTHERLOCTYPE: an optional string attribute used to indicate an alternative LOCTYPE if the LOCTYPE attribute itself has a value of "OTHER";

Returns:

String

getRole

public Object getRole()

Returns the value of field 'role'.

Returns:

Object

getShow

public Object getShow()

Returns the value of field 'show'.

Returns:

Object

getTitle

public Object getTitle()

Returns the value of field 'title'.

Returns:

Object

getType

public String getType()

Returns the value of field 'type'.

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

removeCONTENTIDS

public boolean removeCONTENTIDS(String vCONTENTIDS)

Method removeCONTENTIDS

Parameters:

vCONTENTIDS -

Returns:

boolean

setActuate

public void setActuate(Object actuate)

Sets the value of field 'actuate'.

Parameters:

actuate - the value of field 'actuate'.

setArcrole

public void setArcrole(Object arcrole)

Sets the value of field 'arcrole'.

Parameters:

arcrole - the value of field 'arcrole'.

setCONTENTIDS

public void setCONTENTIDS(int index,
                          String vCONTENTIDS)
                   throws IndexOutOfBoundsException

Method setCONTENTIDS

Parameters:

index -

vCONTENTIDS -

Throws:

IndexOutOfBoundsException

setCONTENTIDS

public void setCONTENTIDS(String[] CONTENTIDSArray)

Method setCONTENTIDS

Parameters:

CONTENTIDSArray -

setHref

public void setHref(Object href)

Sets the value of field 'href'.

Parameters:

href - the value of field 'href'.

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

setLOCTYPE

public void setLOCTYPE(ObjectTypeLOCTYPEType LOCTYPE)

Sets the value of field 'LOCTYPE'. The field 'LOCTYPE' has the following description: LOCTYPE: Location Type the type of locator used to reference a file. It must have one of the following values: URN: Uniform Resource Name URL: Uniform Resource Locator PURL: Persistent URL HANDLE: a CNRI Handle DOI: A Digital Object Identifier OTHER: a form of locator not specified above.

Parameters:

LOCTYPE - the value of field 'LOCTYPE'.

setOTHERLOCTYPE

public void setOTHERLOCTYPE(String OTHERLOCTYPE)

Sets the value of field 'OTHERLOCTYPE'. The field 'OTHERLOCTYPE' has the following description: OTHERLOCTYPE: an optional string attribute used to indicate an alternative LOCTYPE if the LOCTYPE attribute itself has a value of "OTHER";

Parameters:

OTHERLOCTYPE - the value of field 'OTHERLOCTYPE'.

setRole

public void setRole(Object role)

Sets the value of field 'role'.

Parameters:

role - the value of field 'role'.

setShow

public void setShow(Object show)

Sets the value of field 'show'.

Parameters:

show - the value of field 'show'.

setTitle

public void setTitle(Object title)

Sets the value of field 'title'.

Parameters:

title - the value of field 'title'.

setType

public void setType(String type)

Sets the value of field 'type'.

Parameters:

type - the value of field 'type'.

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