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

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

All Implemented Interfaces:

Serializable

public class FContent
extends Object
implements Serializable

FContent: file content. The FContent element is used to deliver a content file for a METS document within the METS file itself. The content file must be either Base 64 encoded, and contained within the subsidiary binData wrapper element, or consist of XML information and be contained within the subsidiary xmlData wrapper element.

See Also:

Serialized Form

Constructor Summary

FContent()

Method Summary

byte[]	getBinData() Returns the value of field 'binData'.
String	getID() Returns the value of field 'ID'.
String	getUSE() Returns the value of field 'USE'.
XmlData	getXmlData() Returns the value of field 'xmlData'.
boolean	isValid() Method isValid
void	marshal(ContentHandler handler) Method marshal
void	marshal(Writer out) Method marshal
void	setBinData(byte[] binData) Sets the value of field 'binData'.
void	setID(String ID) Sets the value of field 'ID'.
void	setUSE(String USE) Sets the value of field 'USE'.
void	setXmlData(XmlData xmlData) Sets the value of field 'xmlData'.
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

FContent

public FContent()

Method Detail

getBinData

public byte[] getBinData()

Returns the value of field 'binData'. The field 'binData' has the following description: binData: A wrapper element used to contain a Base64 encoded file.

Returns:

byte

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

getUSE

public String getUSE()

Returns the value of field 'USE'. The field 'USE' has the following description: USE: an optional string indicating the intended use of the embedded file. Examples might include "master", "reference", and "thumbnail" for image files.

Returns:

String

getXmlData

public XmlData getXmlData()

Returns the value of field 'xmlData'. The field 'xmlData' has the following description: xmlData: A wrapper element used to contain an XML encoded file.

Returns:

XmlData

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

setBinData

public void setBinData(byte[] binData)

Sets the value of field 'binData'. The field 'binData' has the following description: binData: A wrapper element used to contain a Base64 encoded file.

Parameters:

binData - the value of field 'binData'.

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

setUSE

public void setUSE(String USE)

Sets the value of field 'USE'. The field 'USE' has the following description: USE: an optional string indicating the intended use of the embedded file. Examples might include "master", "reference", and "thumbnail" for image files.

Parameters:

USE - the value of field 'USE'.

setXmlData

public void setXmlData(XmlData xmlData)

Sets the value of field 'xmlData'. The field 'xmlData' has the following description: xmlData: A wrapper element used to contain an XML encoded file.

Parameters:

xmlData - the value of field 'xmlData'.

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