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

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

All Implemented Interfaces:

Serializable

public class SmLink
extends Object
implements Serializable

smLink: structural map Link An element linking two elements in the structural map, used to indicate that a hyperlink exists between the two METS components represented by the two structural map nodes. You would use smLink, for example, to record the existence of hypertext links between web pages, if you wish to record those links' existence inside of METS.

See Also:

Serialized Form

Constructor Summary

SmLink()

Method Summary

Object	getActuate() Returns the value of field 'actuate'.
Object	getArcrole() Returns the value of field 'arcrole'.
Object	getFrom() Returns the value of field 'from'.
String	getID() Returns the value of field 'ID'.
Object	getShow() Returns the value of field 'show'.
Object	getTitle() Returns the value of field 'title'.
Object	getTo() Returns the value of field 'to'.
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	setFrom(Object from) Sets the value of field 'from'.
void	setID(String ID) Sets the value of field 'ID'.
void	setShow(Object show) Sets the value of field 'show'.
void	setTitle(Object title) Sets the value of field 'title'.
void	setTo(Object to) Sets the value of field 'to'.
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

SmLink

public SmLink()

Method Detail

getActuate

public Object getActuate()

Returns the value of field 'actuate'. The field 'actuate' has the following description: xlink:actuate - see the xlink specification at http://www.w3.org/TR/xlink/

Returns:

Object

getArcrole

public Object getArcrole()

Returns the value of field 'arcrole'. The field 'arcrole' has the following description: xlink:arcrole - the role of the link, as per the xlink specification. See http://www.w3.org/TR/xlink/

Returns:

Object

getFrom

public Object getFrom()

Returns the value of field 'from'. The field 'from' has the following description: xlink:from - the value of the label for the element in the structMap you are linking from.

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

getShow

public Object getShow()

Returns the value of field 'show'. The field 'show' has the following description: xlink:show - see the xlink specification at http://www.w3.org/TR/xlink/

Returns:

Object

getTitle

public Object getTitle()

Returns the value of field 'title'. The field 'title' has the following description: xlink:title - a title for the link (if needed), as per the xlink specification. See http://www.w3.org/TR/xlink/

Returns:

Object

getTo

public Object getTo()

Returns the value of field 'to'. The field 'to' has the following description: xlink:to - the value of the label for the element in the structMap you are linking to.

Returns:

Object

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'. The field 'actuate' has the following description: xlink:actuate - see the xlink specification at http://www.w3.org/TR/xlink/

Parameters:

actuate - the value of field 'actuate'.

setArcrole

public void setArcrole(Object arcrole)

Sets the value of field 'arcrole'. The field 'arcrole' has the following description: xlink:arcrole - the role of the link, as per the xlink specification. See http://www.w3.org/TR/xlink/

Parameters:

arcrole - the value of field 'arcrole'.

setFrom

public void setFrom(Object from)

Sets the value of field 'from'. The field 'from' has the following description: xlink:from - the value of the label for the element in the structMap you are linking from.

Parameters:

from - the value of field 'from'.

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

setShow

public void setShow(Object show)

Sets the value of field 'show'. The field 'show' has the following description: xlink:show - see the xlink specification at http://www.w3.org/TR/xlink/

Parameters:

show - the value of field 'show'.

setTitle

public void setTitle(Object title)

Sets the value of field 'title'. The field 'title' has the following description: xlink:title - a title for the link (if needed), as per the xlink specification. See http://www.w3.org/TR/xlink/

Parameters:

title - the value of field 'title'.

setTo

public void setTo(Object to)

Sets the value of field 'to'. The field 'to' has the following description: xlink:to - the value of the label for the element in the structMap you are linking to.

Parameters:

to - the value of field 'to'.

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