com.orchestranetworks.service
Class ExportSpec

java.lang.Object
  com.orchestranetworks.service.ExportSpec

public class ExportSpec

extends Object

Defines the features of an export.

For being valid, an instance of this class must at least define a source and a destination.

See Also:

ProcedureContext.doExport(ExportSpec)

Constructor Summary

ExportSpec()

Method Summary

File	getDestinationFile()
OutputStream	getDestinationStream()
Request	getRequest()
SchemaNode	getSelection()
Adaptation	getSourceAdaptation()
boolean	isCheckAccessRules() Specifies if acces rules have to be check for each records.
boolean	isCloseStreamWhenFinished()
boolean	isContentIndented()
boolean	isIncludesComputedValues()
boolean	isIncludesTechnicalData()
void	setCheckAccessRules(boolean checkAccessRules)
void	setCloseStreamWhenFinished(boolean closeStreamWhenFinished) Specifies that the export process must close the stream at the end.
void	setContentIndented(boolean indent) Specifies that the export process must indent the content of the document.
void	setDestinationFile(File target) Specifies that the export process must generate the file specified.
void	setDestinationStream(OutputStream target) Specifies that the export process must write the document to the stream specified.
void	setIncludesComputedValues(boolean includesComputedValues) Specifies whether computed values must be included in the XML export.
void	setIncludesTechnicalData(boolean includesTechnicalData) Specifies whether technical data must be included in the export.
void	setRequest(Request request) Specifies that the export will process the table content filtered by the given request.
void	setSelection(SchemaNode selection) Specifies that the export will include only the content under the node specified.
void	setSourceAdaptation(Adaptation aSource) Specifies the source of the export (mandatory property).
String	toString()
String	toStringInfo() Returns information about the main attributes of this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExportSpec

public ExportSpec()

Method Detail

getSourceAdaptation

public Adaptation getSourceAdaptation()

See Also:

setSourceAdaptation(Adaptation)

setSourceAdaptation

public void setSourceAdaptation(Adaptation aSource)

Specifies the source of the export (mandatory property).

Parameters:

aSource - the adaptation to export.

isIncludesComputedValues

public boolean isIncludesComputedValues()

See Also:

setIncludesComputedValues(boolean)

setIncludesComputedValues

public void setIncludesComputedValues(boolean includesComputedValues)

Specifies whether computed values must be included in the XML export. Computed values are the nodes with an osd:function declaration (see Computed Values).

Warning: if false is specified, the exported XML document may be invalid. This occurs when a computed value node has maxOccurs > 0.

If not set, this property is true.

isIncludesTechnicalData

public boolean isIncludesTechnicalData()

See Also:

setIncludesTechnicalData(boolean)

setIncludesTechnicalData

public void setIncludesTechnicalData(boolean includesTechnicalData)

Specifies whether technical data must be included in the export. Technical data are internal repository informations, for example XML attributes x:lastTime or x:uuid.

If not set, this property is true.

getSelection

public SchemaNode getSelection()

See Also:

setSelection(SchemaNode)

setSelection

public void setSelection(SchemaNode selection)

Specifies that the export will include only the content under the node specified.

If not set, this property is null. This means that all the content is exported.

getDestinationFile

public File getDestinationFile()

See Also:

setDestinationFile(File)

setDestinationFile

public void setDestinationFile(File target)

Specifies that the export process must generate the file specified.

If the destination file is not set, the output stream should be set.

Parameters:

target - destination file that the export will write.

See Also:

setDestinationStream(OutputStream)

getDestinationStream

public OutputStream getDestinationStream()

See Also:

setDestinationStream(OutputStream)

setDestinationStream

public void setDestinationStream(OutputStream target)

Specifies that the export process must write the document to the stream specified.

The destination stream is a more general alternative than the destination file.

It is up to the caller of this method to provide a buffered output stream (if needed for performance).

Parameters:

target - destination stream of the export.

See Also:

setDestinationFile(File)

isContentIndented

public boolean isContentIndented()

See Also:

setContentIndented(boolean)

setContentIndented

public void setContentIndented(boolean indent)

Specifies that the export process must indent the content of the document.

If not set, this property is true.

isCloseStreamWhenFinished

public boolean isCloseStreamWhenFinished()

See Also:

setCloseStreamWhenFinished(boolean)

setCloseStreamWhenFinished

public void setCloseStreamWhenFinished(boolean closeStreamWhenFinished)

Specifies that the export process must close the stream at the end.

If not set, this property is true.

toStringInfo

public String toStringInfo()

Returns information about the main attributes of this instance.

toString

public String toString()

getRequest

public Request getRequest()

See Also:

setRequest(Request)

setRequest

public void setRequest(Request request)

Specifies that the export will process the table content filtered by the given request.

If not set, this property is null. This means that all table content is exported.

isCheckAccessRules

public boolean isCheckAccessRules()

Specifies if acces rules have to be check for each records. Default is set to false which means the user doing the operation will have in the export file records that he cannot access through the manager.

setCheckAccessRules

public void setCheckAccessRules(boolean checkAccessRules)