org.eclipse.birt.report.model.api
Class JoinConditionHandle

java.lang.Object
  org.eclipse.birt.report.model.api.ElementDetailHandle
      org.eclipse.birt.report.model.api.ValueHandle
          org.eclipse.birt.report.model.api.StructureHandle
              org.eclipse.birt.report.model.api.JoinConditionHandle

public class JoinConditionHandle
extends StructureHandle

Represents a handle of condition used for joint dataset. The joint dataset is dataset joined by several normal datasets on join conditions. Each join condition has following properties:

Join Type

the join type of the join condition which can be inner join, left out join and right out join.

Operator

the join condition's comparison operator

Left Dataset

the left dataset of the join condition.

Right Dataset

the right dataset of the join condition.

Left Expression

the left expression of the join condition.

Right Expression

the right expression of the join condition.

Field Summary

Fields inherited from class org.eclipse.birt.report.model.api.StructureHandle

structRef

Fields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle

elementHandle

Constructor Summary

JoinConditionHandle(SimpleValueHandle valueHandle, int index)
Constructs the handle of join condition.

Method Summary

java.lang.String	getJoinType() Returns join type value this condition.
java.lang.String	getLeftDataSet() Returns left data set value this condition.
java.lang.String	getLeftExpression() Returns left expression value this condition.
java.lang.String	getOperator() Returns operator value this condition.
java.lang.Object	getProperty(java.lang.String memberName) Gets the value of a member.
java.lang.String	getRightDataSet() Returns right data set value this condition.
java.lang.String	getRightExpression() Returns right expression value this condition.
protected java.lang.String	getStringProperty(java.lang.String memberName) Get the string value of a member.
void	setJoinType(java.lang.String type) Sets the join type value of this condition.
void	setLeftDataSet(java.lang.String leftDataset) Sets the left data set value of this condition.
void	setLeftExpression(java.lang.String leftExpression) Sets the left expression value of this condition.
void	setOperator(java.lang.String operator) Sets the operator value of this condition.
void	setRightDataSet(java.lang.String rightDataset) Sets the right data set value of this condition.
void	setRightExpression(java.lang.String rightExpression) Sets the right expression value of this condition.

Methods inherited from class org.eclipse.birt.report.model.api.StructureHandle

drop, getDefn, getExternalizedValue, getMember, getPropertyDefn, getReference, getStructure, isDesignTime, iterator, setDesignTime, setProperty, setPropertySilently

Methods inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle

getDesign, getElement, getElementHandle, getModule

Methods inherited from class java.lang.Object

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

Constructor Detail

JoinConditionHandle

public JoinConditionHandle(SimpleValueHandle valueHandle,
                           int index)

Constructs the handle of join condition.

Parameters:

valueHandle - the value handle for join condition list of one property

index - the position of this join condition in the list

Method Detail

setJoinType

public void setJoinType(java.lang.String type)
                 throws SemanticException

Sets the join type value of this condition.

Parameters:

type - the join type to set

Throws:

SemanticException

getJoinType

public java.lang.String getJoinType()

Returns join type value this condition.

Returns:

the join type value

setOperator

public void setOperator(java.lang.String operator)
                 throws SemanticException

Sets the operator value of this condition.

Parameters:

operator - the operator to set

Throws:

SemanticException

getOperator

public java.lang.String getOperator()

Returns operator value this condition.

Returns:

the operator value

setLeftDataSet

public void setLeftDataSet(java.lang.String leftDataset)

Sets the left data set value of this condition.

Parameters:

leftDataset - the left data set to set

getLeftDataSet

public java.lang.String getLeftDataSet()

Returns left data set value this condition.

Returns:

the left data set value

setRightDataSet

public void setRightDataSet(java.lang.String rightDataset)

Sets the right data set value of this condition.

Parameters:

rightDataset - the right data set to set

getRightDataSet

public java.lang.String getRightDataSet()

Returns right data set value this condition.

Returns:

the right data set value

setLeftExpression

public void setLeftExpression(java.lang.String leftExpression)

Sets the left expression value of this condition.

Parameters:

leftExpression - the left expression to set

getLeftExpression

public java.lang.String getLeftExpression()

Returns left expression value this condition.

Returns:

the left expression value

setRightExpression

public void setRightExpression(java.lang.String rightExpression)

Sets the right expression value of this condition.

Parameters:

rightExpression - the right expression to set

getRightExpression

public java.lang.String getRightExpression()

Returns right expression value this condition.

Returns:

the right expression value

getProperty

public java.lang.Object getProperty(java.lang.String memberName)

Description copied from class: StructureHandle

Gets the value of a member.

Overrides:

getProperty in class StructureHandle

Parameters:

memberName - name of the member to get

Returns:

String value of the member, or null if the member is not set or is not found.

getStringProperty

protected java.lang.String getStringProperty(java.lang.String memberName)

Description copied from class: StructureHandle

Get the string value of a member.

Overrides:

getStringProperty in class StructureHandle

Parameters:

memberName - name of the member to get

Returns:

String value of the member, or null if the member is not set or is not found.