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

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

All Implemented Interfaces:

Serializable

public class Par
extends Object
implements Serializable

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.

See Also:

Serialized Form

Constructor Summary

Par()

Method Summary

void	addArea(Area vArea) Method addArea
void	addArea(int index, Area vArea) Method addArea
void	addSeq(int index, Seq vSeq) Method addSeq
void	addSeq(Seq vSeq) Method addSeq
void	clearArea() Method clearArea
void	clearSeq() Method clearSeq
Enumeration	enumerateArea() Method enumerateArea
Enumeration	enumerateSeq() Method enumerateSeq
Area[]	getArea() Method getArea
Area	getArea(int index) Method getArea
int	getAreaCount() Method getAreaCount
String	getID() Returns the value of field 'ID'.
Seq[]	getSeq() Method getSeq
Seq	getSeq(int index) Method getSeq
int	getSeqCount() Method getSeqCount
boolean	isValid() Method isValid
void	marshal(ContentHandler handler) Method marshal
void	marshal(Writer out) Method marshal
boolean	removeArea(Area vArea) Method removeArea
boolean	removeSeq(Seq vSeq) Method removeSeq
void	setArea(Area[] areaArray) Method setArea
void	setArea(int index, Area vArea) Method setArea
void	setID(String ID) Sets the value of field 'ID'.
void	setSeq(int index, Seq vSeq) Method setSeq
void	setSeq(Seq[] seqArray) Method setSeq
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

Par

public Par()

Method Detail

addArea

public void addArea(Area vArea)
             throws IndexOutOfBoundsException

Method addArea

Parameters:

vArea -

Throws:

IndexOutOfBoundsException

addArea

public void addArea(int index,
                    Area vArea)
             throws IndexOutOfBoundsException

Method addArea

Parameters:

index -

vArea -

Throws:

IndexOutOfBoundsException

addSeq

public void addSeq(Seq vSeq)
            throws IndexOutOfBoundsException

Method addSeq

Parameters:

vSeq -

Throws:

IndexOutOfBoundsException

addSeq

public void addSeq(int index,
                   Seq vSeq)
            throws IndexOutOfBoundsException

Method addSeq

Parameters:

index -

vSeq -

Throws:

IndexOutOfBoundsException

clearArea

public void clearArea()

Method clearArea

clearSeq

public void clearSeq()

Method clearSeq

enumerateArea

public Enumeration enumerateArea()

Method enumerateArea

Returns:

Enumeration

enumerateSeq

public Enumeration enumerateSeq()

Method enumerateSeq

Returns:

Enumeration

getArea

public Area getArea(int index)
             throws IndexOutOfBoundsException

Method getArea

Parameters:

index -

Returns:

Area

Throws:

IndexOutOfBoundsException

getArea

public Area[] getArea()

Method getArea

Returns:

Area

getAreaCount

public int getAreaCount()

Method getAreaCount

Returns:

int

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

getSeq

public Seq getSeq(int index)
           throws IndexOutOfBoundsException

Method getSeq

Parameters:

index -

Returns:

Seq

Throws:

IndexOutOfBoundsException

getSeq

public Seq[] getSeq()

Method getSeq

Returns:

Seq

getSeqCount

public int getSeqCount()

Method getSeqCount

Returns:

int

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

removeArea

public boolean removeArea(Area vArea)

Method removeArea

Parameters:

vArea -

Returns:

boolean

removeSeq

public boolean removeSeq(Seq vSeq)

Method removeSeq

Parameters:

vSeq -

Returns:

boolean

setArea

public void setArea(int index,
                    Area vArea)
             throws IndexOutOfBoundsException

Method setArea

Parameters:

index -

vArea -

Throws:

IndexOutOfBoundsException

setArea

public void setArea(Area[] areaArray)

Method setArea

Parameters:

areaArray -

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

setSeq

public void setSeq(int index,
                   Seq vSeq)
            throws IndexOutOfBoundsException

Method setSeq

Parameters:

index -

vSeq -

Throws:

IndexOutOfBoundsException

setSeq

public void setSeq(Seq[] seqArray)

Method setSeq

Parameters:

seqArray -

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