Class SearchKey
- java.lang.Object
-
- org.eclipse.birt.report.model.core.Structure
-
- org.eclipse.birt.report.model.api.elements.structures.SearchKey
-
- All Implemented Interfaces:
java.lang.Cloneable,IStructure,org.eclipse.birt.report.model.core.IPropertySet
public class SearchKey extends org.eclipse.birt.report.model.core.StructureStructure for optional list of search criteria. It is used when we defined action in some report item, such as label item, image item and so on, and the action type is drillthrough type. It's provided for drillthrough contents. If the document supports searching, the link can include search criteria. Each search key has the following properties:- Expression
- an expression of the search key for the drillthrough.
- See Also:
Action
-
-
Field Summary
Fields Modifier and Type Field Description protected ExpressionexpressionValue of the expression property.static java.lang.StringEXPRESSION_MEMBERName of the expression property.static java.lang.StringSEARCHKEY_STRUCTName of the structure.
-
Constructor Summary
Constructors Constructor Description SearchKey()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.StringgetExpression()Returns expression value this key.protected java.lang.ObjectgetIntrinsicProperty(java.lang.String propName)Returns the value of a structure property represented as a member variable.java.lang.StringgetStructName()Returns the name of the structure definition.StructureHandlehandle(SimpleValueHandle valueHandle, int index)Creates the specific handle of this structure.voidsetExpression(java.lang.String expression)Sets the expression value of this key.protected voidsetIntrinsicProperty(java.lang.String propName, java.lang.Object value)Sets the value of of a structure property represented as a member variable.-
Methods inherited from class org.eclipse.birt.report.model.core.Structure
checkStringMember, copy, equals, getCompatibleValue, getContext, getDefn, getElement, getExpressionProperty, getHandle, getHandle, getLocalProperty, getLocalProperty, getMemberDefn, getObjectDefn, getProperty, getProperty, getReferencableProperty, getStringProperty, isDesignTime, isReferencable, setContext, setExpressionProperty, setProperty, setProperty, setupContext, updateReference, validate
-
-
-
-
Field Detail
-
SEARCHKEY_STRUCT
public static final java.lang.String SEARCHKEY_STRUCT
Name of the structure.- See Also:
- Constant Field Values
-
EXPRESSION_MEMBER
public static final java.lang.String EXPRESSION_MEMBER
Name of the expression property.- See Also:
- Constant Field Values
-
expression
protected Expression expression
Value of the expression property.
-
-
Method Detail
-
getStructName
public java.lang.String getStructName()
Description copied from interface:IStructureReturns the name of the structure definition. The name is the one used to define the structure in the meta-data dictionary.- Returns:
- the internal name of the structure a defined in the meta-data dictionary.
-
getIntrinsicProperty
protected java.lang.Object getIntrinsicProperty(java.lang.String propName)
Description copied from class:org.eclipse.birt.report.model.core.StructureReturns the value of a structure property represented as a member variable.- Specified by:
getIntrinsicPropertyin classorg.eclipse.birt.report.model.core.Structure- Parameters:
propName- name of the property- Returns:
- the value of the property, or null if the property is not set
-
setIntrinsicProperty
protected void setIntrinsicProperty(java.lang.String propName, java.lang.Object value)Description copied from class:org.eclipse.birt.report.model.core.StructureSets the value of of a structure property represented as a member variable.- Specified by:
setIntrinsicPropertyin classorg.eclipse.birt.report.model.core.Structure- Parameters:
propName- the name of the property to setvalue- the property value
-
setExpression
public void setExpression(java.lang.String expression)
Sets the expression value of this key.- Parameters:
expression- the expression to set
-
getExpression
public java.lang.String getExpression()
Returns expression value this key.- Returns:
- the expression value
-
handle
public StructureHandle handle(SimpleValueHandle valueHandle, int index)
Description copied from class:org.eclipse.birt.report.model.core.StructureCreates the specific handle of this structure. This handle is always created.- Specified by:
handlein classorg.eclipse.birt.report.model.core.Structure- Parameters:
valueHandle- the value handle of this structure list property this structure is inindex- the position of this structure in structure list- Returns:
- the handle of this structure.
-
-