com.adobe.icc.render.obj
Class Content

java.lang.Object
  com.adobe.icc.render.obj.Content

All Implemented Interfaces:

java.io.Serializable

public class Content
extends java.lang.Object
implements java.io.Serializable

Holder object for the type and data of a resolved Data Module.

See Also:

Serialized Form

Nested Class Summary

static class

Content.ModuleType Enum to specify the type of module.

Constructor Summary

Content(Content.ModuleType moduleType, byte[] data, java.lang.String toolTip, MimeType mimeType, java.lang.String moduleId)
Constructor with parameters.

Content(Content.ModuleType moduleType, byte[] data, java.lang.String toolTip, MimeType mimeType, java.lang.String moduleId, boolean empty)
Constructor with parameters.

Content(Content.ModuleType moduleType, byte[] data, java.lang.String toolTip, MimeType mimeType, java.lang.String moduleId, boolean empty, java.util.Vector ancestry)
Constructor with parameters.

Content(Content.ModuleType moduleType, byte[] data, java.lang.String toolTip, MimeType mimeType, java.lang.String moduleId, boolean empty, java.util.Vector ancestry, int moduleIdent)
Constructor with parameters.

Method Summary

void	applyAncestry(java.util.Vector ancestry) Sets the lineage (Object[][]) based on the ancestry (Vector
byte[]	getData() Returns the module content as byte[].
java.lang.Byte[]	getDataArray() Returns the module content as Byte[].
java.lang.Object[][]	getLineage() Returns array of arrays where sub-array index 0 is a String representing the GUID of every parent module in the result's lineage if the content was nested in a list or condition.
MimeType	getMimeType() Returns mime type of module content.
java.lang.String	getModuleId() Returns the module id.
int	getModuleIdent() Returns the indentation value.
Content.ModuleType	getModuleType() Returns the module type.
java.util.Set	getParentKeepWithNext()
java.lang.String	getToolTip() Returns the module tool tip.
boolean	isEmpty() Returns true if the content is explicitly empty (e.g.
boolean	isKeepWithNext()
boolean	isNoPageBreak()
boolean	isOriginalKeepWithNext()
boolean	isOriginalNoPageBreak()
void	setData(byte[] data) Sets the module content as byte[].
void	setDataArray(java.lang.Byte[] dataArray) Sets the module content as Byte[].
void	setEmpty(boolean empty) Sets flag to indicate that module content is empty.
void	setKeepWithNext(boolean keepWithNext)
void	setLineage(java.lang.Object[][] lineage) Sets lineage of this content.
void	setMimeType(MimeType mimeType) Sets mime type of module content.
void	setModuleId(java.lang.String moduleId) Sets the module id.
void	setModuleIdent(int moduleIdent) Sets the indentation value.
void	setModuleType(Content.ModuleType moduleType) Sets the module type.
void	setNoPageBreak(boolean noPageBreak)
void	setOriginalKeepWithNext(boolean originalKeepWithNext)
void	setOriginalNoPageBreak(boolean originalNoPageBreak)
void	setParentKeepWithNext(java.util.Set parentKeepWithNext)
void	setToolTip(java.lang.String toolTip) Sets module tool tip.

Methods inherited from class java.lang.Object

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

Constructor Detail

Content

public Content(Content.ModuleType moduleType,
               byte[] data,
               java.lang.String toolTip,
               MimeType mimeType,
               java.lang.String moduleId)

Constructor with parameters.

Parameters:

moduleType - type of the module.

data - content of module.

toolTip - module tooltip.

mimeType - mime type of module content.

moduleId - id of module.

Content

public Content(Content.ModuleType moduleType,
               byte[] data,
               java.lang.String toolTip,
               MimeType mimeType,
               java.lang.String moduleId,
               boolean empty)

Constructor with parameters.

Parameters:

moduleType - type of the module.

data - content of module.

toolTip - module tooltip.

mimeType - mime type of module content.

moduleId - id of module.

empty - flag to indiciate that module is empty.

Content

public Content(Content.ModuleType moduleType,
               byte[] data,
               java.lang.String toolTip,
               MimeType mimeType,
               java.lang.String moduleId,
               boolean empty,
               java.util.Vector ancestry)

Constructor with parameters.

Parameters:

moduleType - type of the module.

data - content of module.

toolTip - module tooltip.

mimeType - mime type of module content.

moduleId - id of module.

empty - flag to indiciate that module is empty.

ancestry - ancestry.

Content

public Content(Content.ModuleType moduleType,
               byte[] data,
               java.lang.String toolTip,
               MimeType mimeType,
               java.lang.String moduleId,
               boolean empty,
               java.util.Vector ancestry,
               int moduleIdent)

Constructor with parameters.

Parameters:

moduleType - type of the module.

data - content of module.

toolTip - module tooltip.

mimeType - mime type of module content.

moduleId - id of module.

empty - flag to indiciate that module is empty.

ancestry - ancestry.

moduleIdent - indentation level of module.

Method Detail

getModuleType

public Content.ModuleType getModuleType()

Returns the module type.

Returns:

module type.

setModuleType

public void setModuleType(Content.ModuleType moduleType)

Sets the module type.

Parameters:

moduleType - module type.

getData

public byte[] getData()

Returns the module content as byte[].

Returns:

module content

setData

public void setData(byte[] data)

Sets the module content as byte[].

Parameters:

data - module content

getToolTip

public java.lang.String getToolTip()

Returns the module tool tip.

Returns:

module tool tip

setToolTip

public void setToolTip(java.lang.String toolTip)

Sets module tool tip.

Parameters:

toolTip - module tool tip

getMimeType

public MimeType getMimeType()

Returns mime type of module content.

Returns:

the mimeType

setMimeType

public void setMimeType(MimeType mimeType)

Sets mime type of module content.

Parameters:

mimeType - the mimeType to set

getDataArray

public java.lang.Byte[] getDataArray()

Returns the module content as Byte[].

Returns:

module content

setDataArray

public void setDataArray(java.lang.Byte[] dataArray)

Sets the module content as Byte[].

Parameters:

data - module content

getModuleId

public java.lang.String getModuleId()

Returns the module id.

Returns:

module id

setModuleId

public void setModuleId(java.lang.String moduleId)

Sets the module id.

Parameters:

moduleId - module id.

isEmpty

public boolean isEmpty()

Returns true if the content is explicitly empty (e.g. represents a list or condition that had no output but was still included in the result set).

Returns:

true if content is empty.

setEmpty

public void setEmpty(boolean empty)

Sets flag to indicate that module content is empty.

Parameters:

empty - indicates that module content is empty

getLineage

public java.lang.Object[][] getLineage()

Returns array of arrays where sub-array index 0 is a String representing the GUID of every parent module in the result's lineage if the content was nested in a list or condition. Sub-array index 1 is an integer >= 0 representing the identifier of each parent module. The array lists every parent in order from oldest to youngest. If the content was not nested, this property is null.

Returns:

array of arrays representing lineage

setLineage

public void setLineage(java.lang.Object[][] lineage)

Sets lineage of this content.

Parameters:

lineage - array of arrays representing lineage

getModuleIdent

public int getModuleIdent()

Returns the indentation value.

Returns:

the moduleIdent

setModuleIdent

public void setModuleIdent(int moduleIdent)

Sets the indentation value.

Parameters:

moduleIdent - the moduleIdent to set

applyAncestry

public void applyAncestry(java.util.Vector ancestry)

Sets the lineage (Object[][]) based on the ancestry (Vector