ch.specchio.types

Class MetaDocument

java.lang.Object

ch.specchio.types.MetaParameter

ch.specchio.types.MetaFile

ch.specchio.types.MetaDocument

public class MetaDocument
extends MetaFile

Meta-parameter type for documents.

Field Summary

Fields inherited from class ch.specchio.types.MetaParameter

CALIBRATION_LEVEL, HIERARCHY_LEVEL, SPECTRUM_LEVEL

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MetaDocument() default constructor
protected	MetaDocument(attribute attr) constructor from an attribute definition
protected	MetaDocument(attribute attr, java.lang.Object meta_value) Constructor from attribute and value
protected	MetaDocument(java.lang.String category_name, java.lang.String category_value, java.lang.Object meta_value) constructor from a category name and value

Method Summary

Modifier and Type	Method and Description
boolean	allows_multi_insert() returns "true" to indicate that documents can be inserted monolithic statements
java.lang.String	getDefaultFilenameExtension() returns ".pdf" since this is the only type of file we support
boolean	hasEqualValue(MetaParameter mp)
void	readValue(java.io.InputStream is, java.lang.String mimeType) read the meta-parameter value from an input stream
void	setEmptyValue() initialise the meta-parameter with an empty value
void	setValue(java.lang.Object value)
static boolean	supportsValue(java.lang.Object value)
java.lang.String	valueAsString()
void	writeValue(java.io.OutputStream os) write the document to an output stream

Methods inherited from class ch.specchio.types.MetaParameter

getAnnotation, getAttributeId, getAttributeName, getBlob_lazy_loading, getBlob_size_in_MB, getBlob_size, getCategoryName, getCategoryValue, getDefaultStorageField, getDefaultUnitId, getDescription, getEavId, getEAVValue, getFieldPos, getIsBooleanValue, getLevel, getUnitId, getUnitName, getValue, newInstance, newInstance, newInstance, setAnnotation, setAttributeId, setAttributeName, setBlob_lazy_loading, setBlob_size, setCategoryName, setCategoryValue, setDefaultStorageField, setDefaultUnitId, setDescription, setEavId, setIsBooleanValue, setLevel, setUnitId, setUnitName, setUnits, setValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetaDocument

protected MetaDocument()

default constructor

MetaDocument

protected MetaDocument(attribute attr)

constructor from an attribute definition

MetaDocument

protected MetaDocument(java.lang.String category_name,
                       java.lang.String category_value,
                       java.lang.Object meta_value)
                throws MetaParameterFormatException

constructor from a category name and value

Throws:

MetaParameterFormatException

MetaDocument

protected MetaDocument(attribute attr,
                       java.lang.Object meta_value)
                throws MetaParameterFormatException

Constructor from attribute and value

Parameters:

attr - the attribute

meta_value - the metaparameter value

Throws:

MetaParameterFormatException - meta_value cannot be assigned to a file meta-parameter

Method Detail

allows_multi_insert

public boolean allows_multi_insert()

returns "true" to indicate that documents can be inserted monolithic statements

Specified by:

allows_multi_insert in class MetaParameter

hasEqualValue

public boolean hasEqualValue(MetaParameter mp)

Specified by:

hasEqualValue in class MetaParameter

getDefaultFilenameExtension

public java.lang.String getDefaultFilenameExtension()

returns ".pdf" since this is the only type of file we support

Specified by:

getDefaultFilenameExtension in class MetaFile

Returns:

the default filename extension, including the "."

readValue

public void readValue(java.io.InputStream is,
                      java.lang.String mimeType)
               throws java.io.IOException

read the meta-parameter value from an input stream

Specified by:

readValue in class MetaFile

Parameters:

is - the input stream

mimeType - the MIME type of the input data

Throws:

java.io.IOException - read error

setEmptyValue

public void setEmptyValue()

initialise the meta-parameter with an empty value

Specified by:

setEmptyValue in class MetaParameter

setValue

public void setValue(java.lang.Object value)
              throws MetaParameterFormatException

Overrides:

setValue in class MetaParameter

Throws:

MetaParameterFormatException

supportsValue

public static boolean supportsValue(java.lang.Object value)

valueAsString

public java.lang.String valueAsString()

Specified by:

valueAsString in class MetaParameter

writeValue

public void writeValue(java.io.OutputStream os)
                throws java.io.IOException

write the document to an output stream

Specified by:

writeValue in class MetaFile

Parameters:

os - the output stream

Throws:

java.io.IOException - write error