com.saperion.structures

Class Structure

java.lang.Object

com.saperion.structures.Structure

All Implemented Interfaces:

Serializable

public class Structure
extends Object
implements Serializable

A structure bean for structuring content stream with their variables.

Author:

dam

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ContentStream[]	contentStreams This structures contents.
protected int	selectedImage Selected image of this structure.
protected Map<String,String>	variables Thus structures variables.

Constructor Summary

Constructors

Constructor and Description
Structure(ContentStream[] content) Creates a new UpdateDocumentInfo.

Method Summary

Modifier and Type	Method and Description
Structure	addVariable(String varName, String varValue) Adds a variable to this structure.
ContentStream[]	getContent()
int	getSelectedImage()
Map<String,String>	getVariables() Returns this structures variables.
void	setSelectedImage(int elementNumber)

Methods inherited from class java.lang.Object

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

Field Detail

contentStreams

protected transient ContentStream[] contentStreams

This structures contents.

variables

protected Map<String,String> variables

Thus structures variables.

selectedImage

protected int selectedImage

Selected image of this structure.

Constructor Detail

Structure

public Structure(@Nonnull
                 ContentStream[] content)

Creates a new UpdateDocumentInfo.

Parameters:

content - Multiple content data. If the array is empty, all content of the document will be removed. If null, the content will not be changed. Otherwise only the contained elements will be replaced.

Method Detail

getContent

public ContentStream[] getContent()

Returns:

content stream

setSelectedImage

public void setSelectedImage(int elementNumber)

Parameters:

elementNumber - Element to mark

getSelectedImage

public int getSelectedImage()

Returns:

Element to mark

getVariables

public Map<String,String> getVariables()

Returns this structures variables.

Returns:

this structures variables.

addVariable

public Structure addVariable(String varName,
                             String varValue)

Adds a variable to this structure.

Parameters:

varName - The name of the variable.

varValue - The value of the variable.

Returns:

This structure.