com.apelon.dts.common.subset
Class PreviewOptions

java.lang.Object
  com.apelon.dts.common.subset.PreviewOptions

public class PreviewOptions
extends Object

Class for setting options when previewing full and differences between subset expressions.

Copyright: Copyright (c) 2005

Company: Apelon Inc.

Since:

3.4.0

Version:

DTS 3.4.0

Author:

Apelon Inc.

Field Summary

static int	DIFF_ADDITIONS
static int	DIFF_DELETIONS
static int	FULL
static PreviewOptions	PREVIEW_DIFF_ADDITIONS
static PreviewOptions	PREVIEW_DIFF_DELETIONS
static PreviewOptions	PREVIEW_FULL

Constructor Summary

PreviewOptions()
No-arg constructor.

Method Summary

int	getLimit() Gets the limit on the number of preview results to be returned.
int	getPreviewType() Returns the preview type set on this object.
String	getSubsetExpression() The subset expression which for which preview is computed.
int	getSubsetId() Gets the id of the subset against which the preview difference is computed.
void	setLimit(int limit) Sets the maximum number of results that should be returned for the preview.
void	setPreviewType(int previewType) Sets the preview type.
void	setSubsetExpression(String expression) The subset expression whose preview needs to be computed.
void	setSubsetId(int subsetId) The id of the subset against which preview differences (DIFF_ADDITIONS or DIFF_DELETIONS) needs to be computed.

Methods inherited from class java.lang.Object

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

Field Detail

DIFF_ADDITIONS

public static final int DIFF_ADDITIONS

See Also:

Constant Field Values

DIFF_DELETIONS

public static final int DIFF_DELETIONS

See Also:

Constant Field Values

FULL

public static final int FULL

See Also:

Constant Field Values

PREVIEW_FULL

public static final PreviewOptions PREVIEW_FULL

PREVIEW_DIFF_ADDITIONS

public static final PreviewOptions PREVIEW_DIFF_ADDITIONS

PREVIEW_DIFF_DELETIONS

public static final PreviewOptions PREVIEW_DIFF_DELETIONS

Constructor Detail

PreviewOptions

public PreviewOptions()

No-arg constructor.

Method Detail

setPreviewType

public void setPreviewType(int previewType)

Sets the preview type. Valid types are DIFF_ADDITIONS, DIFF_DELETIONS, FULL. If not set, the preview type is set to FULL.

Parameters:

previewType - Valid types are DIFF_ADDITIONS or DIFF_DELETIONS or FULL

getPreviewType

public int getPreviewType()

Returns the preview type set on this object.

Returns:

the type of previewing

setLimit

public void setLimit(int limit)

Sets the maximum number of results that should be returned for the preview. If not set, the preview limit is set to 1000.

Parameters:

limit - the search limit

getLimit

public int getLimit()

Gets the limit on the number of preview results to be returned.

Returns:

the search limit number

setSubsetId

public void setSubsetId(int subsetId)

The id of the subset against which preview differences (DIFF_ADDITIONS or DIFF_DELETIONS) needs to be computed. Note: id is only used for computing differences and not while previewing full (FULL).

Parameters:

subsetId - The id of the subset

getSubsetId

public int getSubsetId()

Gets the id of the subset against which the preview difference is computed.

Returns:

the search limit number

setSubsetExpression

public void setSubsetExpression(String expression)

The subset expression whose preview needs to be computed. This expression is required for both FULL and (DIFF_ADDITIONS or DIFF_DELETIONS) cases.

Parameters:

expression - Subset expression whose preview is to be generated The expression is a XML string generated by the XMLEncoder

getSubsetExpression

public String getSubsetExpression()

The subset expression which for which preview is computed.

Returns:

The subset expression