edu.harvard.hul.ois.mets
Class FLocat

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

All Implemented Interfaces:

MetsIdentifiable, MetsSerializable, MetsValidatable

public class FLocat

extends MetsIDElement

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

FLocat()
Instantiate a new <FLocat> object.

Method Summary

Loctype	getLOCTYPE() Return pre-defined locator type.
java.lang.String	getOTHERLOCTYPE() Return other locator type.
java.lang.String	getUSE() Return use flag for this fileGrp.
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.
void	read(MetsReader r) De-serialize the content of the file into this element using the given reader.
static FLocat	reader(MetsReader r) Instantiate a FLocat object de-serialized from the input stream.
void	setLOCTYPE(Loctype type) Set pre-defined locator type.
void	setOTHERLOCTYPE(java.lang.String type) Set other locator type.
void	setUSE(java.lang.String use) Set use flag for this fileGrp.
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	validateThis(MetsValidator v) Validate this element using the given validator.
void	write(MetsWriter w) Serialize the content of this element using the give 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

FLocat

public FLocat()

Instantiate a new <FLocat> object.

Method Detail

getLOCTYPE

public Loctype getLOCTYPE()

Return pre-defined locator type.

Returns:

Type

getOTHERLOCTYPE

public java.lang.String getOTHERLOCTYPE()

Return other locator type.

Returns:

Type

getUSE

public java.lang.String getUSE()

Return use flag for this fileGrp.

Returns:

Use

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

setLOCTYPE

public void setLOCTYPE(Loctype type)

Set pre-defined locator type.

Parameters:

type - Pre-defined type

setOTHERLOCTYPE

public void setOTHERLOCTYPE(java.lang.String type)

Set other locator type.

Parameters:

type - Other type

setUSE

public void setUSE(java.lang.String use)

Set use flag for this fileGrp.

Parameters:

use - Use flag

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

reader

public static FLocat reader(MetsReader r)
                     throws MetsException

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

Parameters:

r - Reader

Returns:

FLocat 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 give 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