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

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

All Implemented Interfaces:

Serializable

public class Fptr
extends Object
implements Serializable

fptr: File Pointer. The fptr element associates a div element with content files that represent that div. It can either point to a file directly itself, via the FILEID attribute, or it can do more complex links to content via the subsidiary area, par and seq elements.

See Also:

Serialized Form

Constructor Summary

Fptr()

Method Summary

void	addCONTENTIDS(int index, String vCONTENTIDS) Method addCONTENTIDS
void	addCONTENTIDS(String vCONTENTIDS) Method addCONTENTIDS
void	clearCONTENTIDS() Method clearCONTENTIDS
Enumeration	enumerateCONTENTIDS() Method enumerateCONTENTIDS
Area	getArea() Returns the value of field 'area'.
String[]	getCONTENTIDS() Method getCONTENTIDS
String	getCONTENTIDS(int index) Method getCONTENTIDS
int	getCONTENTIDSCount() Method getCONTENTIDSCount
Object	getFILEID() Returns the value of field 'FILEID'.
String	getID() Returns the value of field 'ID'.
Par	getPar() Returns the value of field 'par'.
Seq	getSeq() Returns the value of field 'seq'.
boolean	isValid() Method isValid
void	marshal(ContentHandler handler) Method marshal
void	marshal(Writer out) Method marshal
boolean	removeCONTENTIDS(String vCONTENTIDS) Method removeCONTENTIDS
void	setArea(Area area) Sets the value of field 'area'.
void	setCONTENTIDS(int index, String vCONTENTIDS) Method setCONTENTIDS
void	setCONTENTIDS(String[] CONTENTIDSArray) Method setCONTENTIDS
void	setFILEID(Object FILEID) Sets the value of field 'FILEID'.
void	setID(String ID) Sets the value of field 'ID'.
void	setPar(Par par) Sets the value of field 'par'.
void	setSeq(Seq seq) Sets the value of field 'seq'.
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

Fptr

public Fptr()

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

getArea

public Area getArea()

Returns the value of field 'area'. The field 'area' has the following description: area: file area The area element provides for more sophisticated linking between a div element and content files representing that div, be they text, image, audio, or video files. An area element can link a div to a point within a file, to a one-dimension segment of a file (e.g., text screen, image line, audio/video clip), or a two-dimensional section of a file (e.g, subsection of an image, or a subsection of the video display of a video file. See the areaType documentation for more details.

Returns:

Area

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

getFILEID

public Object getFILEID()

Returns the value of field 'FILEID'. The field 'FILEID' has the following description: FILEID: an IDREF to the file element which corresponds with the div containing this ftpr.

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

getPar

public Par getPar()

Returns the value of field 'par'. The field 'par' has the following description: par: Parallel files. The par element should used to link a div to a set of content files when those files should be played/displayed in unison to deliver the content to the user (e.g., displaying a text transcript simultaneously with playing an audio file). A par element has two possible subsidiary elements, which should be used in different cases. In cases where each bytestream to be played in parallel can fit in a single file, you should use subsidiary elements within the par element to point to those files. However, in some cases, bytestreams which should be played in parallel are too large to fit in a single file (high quality multi-track audio, or video). In those cases, you should use subsidiary elements, where each contains the files comprising a particular bytestream in the order they should be played back. So, for example, in the case where you had an audio recording which had to be split into three different, sequential files, and a text transcription of the recording in a single file, you would use a par element containing two seq elements. The first seq element would contain three area elements, one for each audio file; the second seq element would contain a single area element, for the text transcription file.

Returns:

Par

getSeq

public Seq getSeq()

Returns the value of field 'seq'. The field 'seq' has the following description: seq: Sequence of files. The seq element should be used to link a div to a set of content files when those files should be played/displayed sequentially to deliver content to a user. See the seqType documentation for more details.

Returns:

Seq

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

setArea

public void setArea(Area area)

Sets the value of field 'area'. The field 'area' has the following description: area: file area The area element provides for more sophisticated linking between a div element and content files representing that div, be they text, image, audio, or video files. An area element can link a div to a point within a file, to a one-dimension segment of a file (e.g., text screen, image line, audio/video clip), or a two-dimensional section of a file (e.g, subsection of an image, or a subsection of the video display of a video file. See the areaType documentation for more details.

Parameters:

area - the value of field 'area'.

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 -

setFILEID

public void setFILEID(Object FILEID)

Sets the value of field 'FILEID'. The field 'FILEID' has the following description: FILEID: an IDREF to the file element which corresponds with the div containing this ftpr.

Parameters:

FILEID - the value of field 'FILEID'.

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

setPar

public void setPar(Par par)

Sets the value of field 'par'. The field 'par' has the following description: par: Parallel files. The par element should used to link a div to a set of content files when those files should be played/displayed in unison to deliver the content to the user (e.g., displaying a text transcript simultaneously with playing an audio file). A par element has two possible subsidiary elements, which should be used in different cases. In cases where each bytestream to be played in parallel can fit in a single file, you should use subsidiary elements within the par element to point to those files. However, in some cases, bytestreams which should be played in parallel are too large to fit in a single file (high quality multi-track audio, or video). In those cases, you should use subsidiary elements, where each contains the files comprising a particular bytestream in the order they should be played back. So, for example, in the case where you had an audio recording which had to be split into three different, sequential files, and a text transcription of the recording in a single file, you would use a par element containing two seq elements. The first seq element would contain three area elements, one for each audio file; the second seq element would contain a single area element, for the text transcription file.

Parameters:

par - the value of field 'par'.

setSeq

public void setSeq(Seq seq)

Sets the value of field 'seq'. The field 'seq' has the following description: seq: Sequence of files. The seq element should be used to link a div to a set of content files when those files should be played/displayed sequentially to deliver content to a user. See the seqType documentation for more details.

Parameters:

seq - the value of field 'seq'.

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