edu.harvard.hul.ois.mets
Class MdRef

java.lang.Object
  extended byedu.harvard.hul.ois.mets.helper.MetsElement
      extended byedu.harvard.hul.ois.mets.helper.MetsVElement
          extended byedu.harvard.hul.ois.mets.helper.MetsIDElement
              extended byedu.harvard.hul.ois.mets.MdRef
All Implemented Interfaces:
MetsIdentifiable, MetsSerializable, MetsValidatable

public class MdRef
extends MetsIDElement

This class encapsulates the <mdRef> 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
MdRef()
          Instantiate a new <mdRef> object.
 
Method Summary
 java.lang.String getLABEL()
          Return metadata label.
 Loctype getLOCTYPE()
          Return pre-defined locator type.
 Mdtype getMDTYPE()
          Return pre-defined metadata type.
 java.lang.String getMIMETYPE()
          Return metadata MIME type.
 java.lang.String getOTHERLOCTYPE()
          Return other metadata locator type.
 java.lang.String getOTHERMDTYPE()
          Return other metadata type.
 Actuate getXlinkActuate()
          Return pre-defined XLink actuate attribute.
 java.lang.String getXlinkArcrole()
          Return XLink arcrole attribute.
 java.lang.String getXlinkHref()
          Return XLink href attribute.
 java.lang.String getXlinkRole()
          Return XLink role attribute.
 Show getXlinkShow()
          Return pre-defined XLink show attribute.
 java.lang.String getXlinkTitle()
          Return XLink title attribute.
 java.lang.String getXPTR()
          Return reference XPTR.
 void read(MetsReader r)
          De-serialize the content of the file into this element using the given reader.
static MdRef reader(MetsReader r)
          Instantiate a MdRef object de-serialized from the input stream.
 void setLABEL(java.lang.String LABEL)
          Set metadata label.
 void setLOCTYPE(Loctype LOCTYPE)
          Set pre-defined locator type.
 void setMDTYPE(Mdtype MDTYPE)
          Set metadata type.
 void setMIMETYPE(java.lang.String MIMETYPE)
          Set file MIME type.
 void setOTHERLOCTYPE(java.lang.String OTHERLOCTYPE)
          Set other metadata locator type.
 void setOTHERMDTYPE(java.lang.String OTHERMDTYPE)
          Set other metadata type.
 void setXlinkActuate(Actuate actuate)
          Set pre-defined Xlink actuate behavior.
 void setXlinkArcrole(java.lang.String arcrole)
          Set Xlink arcrole attribute.
 void setXlinkHref(java.lang.String href)
          Set Xlink href attribute.
 void setXlinkRole(java.lang.String role)
          Set Xlink role attribute.
 void setXlinkShow(Show show)
          Set pre-defined Xlink show behavior.
 void setXlinkTitle(java.lang.String title)
          Set Xlink title attribute
 void setXPTR(java.lang.String XPTR)
          Set metadata XPTR.
 void validateThis(MetsValidator v)
          Validate this element 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, 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

MdRef

public MdRef()
Instantiate a new <mdRef> object.

Method Detail

getLABEL

public java.lang.String getLABEL()
Return metadata label.

Returns:
Label

getLOCTYPE

public Loctype getLOCTYPE()
Return pre-defined locator type.

Returns:
Type

getMDTYPE

public Mdtype getMDTYPE()
Return pre-defined metadata type.

Returns:
Type

getMIMETYPE

public java.lang.String getMIMETYPE()
Return metadata MIME type.

Returns:
MIME type

getOTHERLOCTYPE

public java.lang.String getOTHERLOCTYPE()
Return other metadata locator type.

Returns:
Type

getOTHERMDTYPE

public java.lang.String getOTHERMDTYPE()
Return other metadata type.

Returns:
Type

getXlinkActuate

public Actuate getXlinkActuate()
Return pre-defined XLink actuate attribute.

Returns:
Actuate

getXlinkArcrole

public java.lang.String getXlinkArcrole()
Return XLink arcrole attribute.

Returns:
Arcrole

getXlinkHref

public java.lang.String getXlinkHref()
Return XLink href attribute.

Returns:
Href

getXlinkRole

public java.lang.String getXlinkRole()
Return XLink role attribute.

Returns:
Role

getXlinkShow

public Show getXlinkShow()
Return pre-defined XLink show attribute.

Returns:
Show

getXlinkTitle

public java.lang.String getXlinkTitle()
Return XLink title attribute.

Returns:
Title

getXPTR

public java.lang.String getXPTR()
Return reference XPTR.

Returns:
XPTR

setLABEL

public void setLABEL(java.lang.String LABEL)
Set metadata label.

Parameters:
LABEL - Label

setLOCTYPE

public void setLOCTYPE(Loctype LOCTYPE)
Set pre-defined locator type.

Parameters:
LOCTYPE - Pre-defined type

setMDTYPE

public void setMDTYPE(Mdtype MDTYPE)
Set metadata type.

Parameters:
MDTYPE - Metadata type

setMIMETYPE

public void setMIMETYPE(java.lang.String MIMETYPE)
Set file MIME type.

Parameters:
MIMETYPE - MIME type

setOTHERLOCTYPE

public void setOTHERLOCTYPE(java.lang.String OTHERLOCTYPE)
Set other metadata locator type.

Parameters:
OTHERLOCTYPE - Other type

setOTHERMDTYPE

public void setOTHERMDTYPE(java.lang.String OTHERMDTYPE)
Set other metadata type.

Parameters:
OTHERMDTYPE - Other type

setXlinkActuate

public void setXlinkActuate(Actuate actuate)
Set pre-defined Xlink actuate behavior.

Parameters:
actuate - Actuate behavior

setXlinkArcrole

public void setXlinkArcrole(java.lang.String arcrole)
Set Xlink arcrole attribute.

Parameters:
arcrole - Arcrole

setXlinkHref

public void setXlinkHref(java.lang.String href)
Set Xlink href attribute.

Parameters:
href - Href

setXlinkRole

public void setXlinkRole(java.lang.String role)
Set Xlink role attribute.

Parameters:
role - Role

setXlinkShow

public void setXlinkShow(Show show)
Set pre-defined Xlink show behavior.

Parameters:
show - Show behavior

setXlinkTitle

public void setXlinkTitle(java.lang.String title)
Set Xlink title attribute

Parameters:
title - Title

setXPTR

public void setXPTR(java.lang.String XPTR)
Set metadata XPTR.

Parameters:
XPTR - XPTR

reader

public static MdRef reader(MetsReader r)
                    throws MetsException
Instantiate a MdRef object de-serialized from the input stream.

Parameters:
r - Reader
Returns:
MdRef 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 with the given validator.

Specified by:
validateThis in interface MetsValidatable
Overrides:
validateThis in class MetsVElement
Parameters:
v - Validator
Throws:
MetsException - Validation exception