Package com.axemble.vdoc.sdk.impl

Class ProcessGenericViewTransformer

java.lang.Object

com.axemble.vdoc.sdk.impl.AbstractElement

com.axemble.vdoc.sdk.impl.base.BaseViewTransformer

com.axemble.vdoc.sdk.impl.base.BaseResourceViewTransformer

com.axemble.vdoc.sdk.impl.ProcessGenericViewTransformer

All Implemented Interfaces:

IGenericViewTransformer, Serializable

public class ProcessGenericViewTransformer
extends com.axemble.vdoc.sdk.impl.base.BaseResourceViewTransformer
implements IGenericViewTransformer

Author:

vlygeros

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.axemble.vdoc.sdk.impl.base.BaseViewTransformer

com.axemble.vdoc.sdk.impl.base.BaseViewTransformer.ViewDesc

Field Summary

Fields inherited from class com.axemble.vdoc.sdk.impl.base.BaseResourceViewTransformer

includeLabels

Fields inherited from class com.axemble.vdoc.sdk.impl.base.BaseViewTransformer

columns, context, count, prefix, start, viewId

Fields inherited from class com.axemble.vdoc.sdk.impl.AbstractElement

module

Constructor Summary

Constructors

Constructor	Description
ProcessGenericViewTransformer(IModule module)

Method Summary

Modifier and Type	Method	Description
protected com.axemble.vdoc.sdk.impl.base.BaseViewTransformer.ViewDesc	buildViewName()
protected void	buildXMLBody(Element parent)
void	setIncludeLabels(boolean includeLabels)	Allows to include or not the labels.
void	setOffset(int offset)	Sets the first element to return.
void	setSecurityApplied(boolean securityApplied)	Specifies if the security should be applied.
void	setStart(int start)	Sets the start page position.
void	viewToXML(IContext context, Element viewDefinition, OutputStream outputStream)	Allows to evaluate a view and transforms the result to an XML stream.

Methods inherited from class com.axemble.vdoc.sdk.impl.base.BaseResourceViewTransformer

buildDocuments, buildResourceXMLBody, buildResourceXMLHeader, buildTasks, searchDocuments

Methods inherited from class com.axemble.vdoc.sdk.impl.base.BaseViewTransformer

buildXMLHeader, notNull, setCount

Methods inherited from class com.axemble.vdoc.sdk.impl.AbstractElement

getModule

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.IGenericViewTransformer

setCount

Constructor Details

ProcessGenericViewTransformer

public ProcessGenericViewTransformer(IModule module)

Parameters:

module -

Method Details

setSecurityApplied

public void setSecurityApplied(boolean securityApplied)

Description copied from interface: IGenericViewTransformer

Specifies if the security should be applied.

Specified by:

setSecurityApplied in interface IGenericViewTransformer

Parameters:

securityApplied - true if the security should be applied, false otherwise.

viewToXML

public void viewToXML(IContext context,
 Element viewDefinition,
 OutputStream outputStream)
               throws IOException

Description copied from interface: IGenericViewTransformer

Allows to evaluate a view and transforms the result to an XML stream.

Specified by:

viewToXML in interface IGenericViewTransformer

Parameters:

context - The execution context.

viewDefinition - The view definition.

outputStream - The OutputStream object.

Throws:

IOException - The

invalid reference

java.io.Exception

default exception.

buildViewName

protected com.axemble.vdoc.sdk.impl.base.BaseViewTransformer.ViewDesc buildViewName()

Specified by:

buildViewName in class com.axemble.vdoc.sdk.impl.base.BaseViewTransformer

buildXMLBody

protected void buildXMLBody(Element parent)

Specified by:

buildXMLBody in class com.axemble.vdoc.sdk.impl.base.BaseViewTransformer

setIncludeLabels

public void setIncludeLabels(boolean includeLabels)

Description copied from interface: IGenericViewTransformer

Allows to include or not the labels. By default, the value is set to true.

Specified by:

setIncludeLabels in interface IGenericViewTransformer

Parameters:

includeLabels - Set to false to avoid labels inclusion.

setOffset

public void setOffset(int offset)

Description copied from interface: IGenericViewTransformer

Sets the first element to return.

Specified by:

setOffset in interface IGenericViewTransformer

Parameters:

offset - The first element to set (0 is the first element).

setStart

public void setStart(int start)

Description copied from interface: IGenericViewTransformer

Sets the start page position.

Specified by:

setStart in interface IGenericViewTransformer

Overrides:

setStart in class com.axemble.vdoc.sdk.impl.base.BaseViewTransformer

Parameters:

start - The start page to set (1 is the first page).