edu.indiana.dlib.metsnav.mets.v1_4
Class MdRef

java.lang.Object
  edu.indiana.dlib.metsnav.mets.v1_4.MdRef

All Implemented Interfaces:

Serializable

public class MdRef
extends Object
implements Serializable

mdRef: metadata reference. The mdRef element is a generic element used throughout the METS schema to provide a pointer to metadata which resides outside the METS document. NB: mdRef is an empty element. The location of the metadata must be recorded in the xlink:href attribute, supplemented by the XPTR attribute as needed.

See Also:

Serialized Form

Constructor Summary

MdRef()

Method Summary

Object	getActuate() Returns the value of field 'actuate'.
Object	getArcrole() Returns the value of field 'arcrole'.
Object	getHref() Returns the value of field 'href'.
String	getID() Returns the value of field 'ID'.
String	getLABEL() Returns the value of field 'LABEL'.
ObjectTypeLOCTYPEType	getLOCTYPE() Returns the value of field 'LOCTYPE'.
MdRefMDTYPEType	getMDTYPE() Returns the value of field 'MDTYPE'.
String	getMIMETYPE() Returns the value of field 'MIMETYPE'.
String	getOTHERLOCTYPE() Returns the value of field 'OTHERLOCTYPE'.
String	getOTHERMDTYPE() Returns the value of field 'OTHERMDTYPE'.
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'.
String	getXPTR() Returns the value of field 'XPTR'.
boolean	isValid() Method isValid
void	marshal(ContentHandler handler) Method marshal
void	marshal(Writer out) Method marshal
void	setActuate(Object actuate) Sets the value of field 'actuate'.
void	setArcrole(Object arcrole) Sets the value of field 'arcrole'.
void	setHref(Object href) Sets the value of field 'href'.
void	setID(String ID) Sets the value of field 'ID'.
void	setLABEL(String LABEL) Sets the value of field 'LABEL'.
void	setLOCTYPE(ObjectTypeLOCTYPEType LOCTYPE) Sets the value of field 'LOCTYPE'.
void	setMDTYPE(MdRefMDTYPEType MDTYPE) Sets the value of field 'MDTYPE'.
void	setMIMETYPE(String MIMETYPE) Sets the value of field 'MIMETYPE'.
void	setOTHERLOCTYPE(String OTHERLOCTYPE) Sets the value of field 'OTHERLOCTYPE'.
void	setOTHERMDTYPE(String OTHERMDTYPE) Sets the value of field 'OTHERMDTYPE'.
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'.
void	setXPTR(String XPTR) Sets the value of field 'XPTR'.
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

MdRef

public MdRef()

Method Detail

getActuate

public Object getActuate()

Returns the value of field 'actuate'.

Returns:

Object

getArcrole

public Object getArcrole()

Returns the value of field 'arcrole'.

Returns:

Object

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

getLABEL

public String getLABEL()

Returns the value of field 'LABEL'. The field 'LABEL' has the following description: LABEL: an optional string attribute providing a label to display to the viewer of the METS document identifying the metadata

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

getMDTYPE

public MdRefMDTYPEType getMDTYPE()

Returns the value of field 'MDTYPE'. The field 'MDTYPE' has the following description: MDTYPE: a required attribute specifying the yype of metadata being pointed at (e.g., MARC, EAD, etc.). It must have one of the following values: MARC: any form of MARC record MODS: metadata in the Library of Congress MODS format EAD: Encoded Archival Description finding aid DC: Dublin Core NISOIMG: NISO Technical Metadata for Digital Still Images LC-AV: technical metadata specified in the Library of Congress A/V prototyping project VRA: Visual Resources Association Core TEIHDR: Text Encoding Initiative Header DDI: Data Documentation Initiative FGDC: Federal Geographic Data Committee metadata OTHER: metadata in a format not specified above.

Returns:

MdRefMDTYPEType

getMIMETYPE

public String getMIMETYPE()

Returns the value of field 'MIMETYPE'. The field 'MIMETYPE' has the following description: MIMETYPE: an optional string attribute providing the MIME type for the metadata being pointed at

Returns:

String

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

getOTHERMDTYPE

public String getOTHERMDTYPE()

Returns the value of field 'OTHERMDTYPE'. The field 'OTHERMDTYPE' has the following description: OTHERMDTYPE: Other Metadata Type an optional string which may be used to record the particular form of metadata referenced by this element when the MDTYPE attribute 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

getXPTR

public String getXPTR()

Returns the value of field 'XPTR'. The field 'XPTR' has the following description: XPTR: an optional string attribute for providing an xptr to a location within the file pointed to by the mdRef element, if applicable.

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

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

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

setLABEL

public void setLABEL(String LABEL)

Sets the value of field 'LABEL'. The field 'LABEL' has the following description: LABEL: an optional string attribute providing a label to display to the viewer of the METS document identifying the metadata

Parameters:

LABEL - the value of field 'LABEL'.

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

setMDTYPE

public void setMDTYPE(MdRefMDTYPEType MDTYPE)

Sets the value of field 'MDTYPE'. The field 'MDTYPE' has the following description: MDTYPE: a required attribute specifying the yype of metadata being pointed at (e.g., MARC, EAD, etc.). It must have one of the following values: MARC: any form of MARC record MODS: metadata in the Library of Congress MODS format EAD: Encoded Archival Description finding aid DC: Dublin Core NISOIMG: NISO Technical Metadata for Digital Still Images LC-AV: technical metadata specified in the Library of Congress A/V prototyping project VRA: Visual Resources Association Core TEIHDR: Text Encoding Initiative Header DDI: Data Documentation Initiative FGDC: Federal Geographic Data Committee metadata OTHER: metadata in a format not specified above.

Parameters:

MDTYPE - the value of field 'MDTYPE'.

setMIMETYPE

public void setMIMETYPE(String MIMETYPE)

Sets the value of field 'MIMETYPE'. The field 'MIMETYPE' has the following description: MIMETYPE: an optional string attribute providing the MIME type for the metadata being pointed at

Parameters:

MIMETYPE - the value of field 'MIMETYPE'.

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

setOTHERMDTYPE

public void setOTHERMDTYPE(String OTHERMDTYPE)

Sets the value of field 'OTHERMDTYPE'. The field 'OTHERMDTYPE' has the following description: OTHERMDTYPE: Other Metadata Type an optional string which may be used to record the particular form of metadata referenced by this element when the MDTYPE attribute has a value of "OTHER".

Parameters:

OTHERMDTYPE - the value of field 'OTHERMDTYPE'.

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

setXPTR

public void setXPTR(String XPTR)

Sets the value of field 'XPTR'. The field 'XPTR' has the following description: XPTR: an optional string attribute for providing an xptr to a location within the file pointed to by the mdRef element, if applicable.

Parameters:

XPTR - the value of field 'XPTR'.

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