WurbletParameter (Tentackle Wurblets 2.0.7 API)

java.lang.Object
- org.tentackle.wurblet.WurbletParameter

All Implemented Interfaces:

WurbletParameterOperand
```
public class WurbletParameter
extends Object
implements WurbletParameterOperand
```
A wurblet parameter.
Holds select, update/set and sorting parameters.

Author:

harald

Constructor Summary

Constructors
Constructor and Description

WurbletParameter(String text)
Constructs a parameter from a wurblet arg.

Constructors
Constructor and Description
`WurbletParameter(String text)` Constructs a parameter from a wurblet arg.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getArg()` name of the method argument.
`Attribute`	`getAttribute()` the model attribute.
`String`	`getComponentEntityName()` Gets the entity name of the component key.
`String`	`getName()` name of the database attribute.
`Relation`	`getRelation()` Gets the relation if this is a relation key.
`String`	`getRelationComponentEntityName()` Gets the component of the related entity pointed to by the relation key.
`String`	`getRelationName()` Gets the relation of the relation key.
`String`	`getRelop()` Gets the relop string. Usually "=?" or " IS NULL" or "=value"
`String`	`getSortMode()` Returns the sortmode if !isKey().
`String`	`getSqlArg()`
`String`	`getText()` Gets the original text.
`String`	`getValue()` predefined value (replaces the ?).
`boolean`	`isArg()`
`boolean`	`isComponentKey()` Returns whether this is a component key.
`boolean`	`isFixed()` fixed value (directly put into sql-statement).
`boolean`	`isRelationKey()` Returns whether this is a relation key.
`boolean`	`isSortKey()` Returns true if this is a sorting parameter.
`boolean`	`isSqlArg()`
`void`	`setArg(String arg)` name of the method argument.
`void`	`setAttribute(Attribute attribute)` the model attribute.
`void`	`setFixed(boolean fixed)` fixed value (directly put into sql-statement).
`void`	`setName(String name)` name of the database attribute.
`void`	`setRelation(Relation relation)` Sets the relation if this is a relation key.
`void`	`setRelop(String relop)` relational operator.
`void`	`setValue(String value)` predefined value (replaces the ?).
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - WurbletParameter
```
public WurbletParameter(String text)
```
    Constructs a parameter from a wurblet arg.
    A parameter is of the form:
    [+-][<attribute-path>]<attribute-name>[[argname]][:relop[:value]|[#value]]
    where relop is optional and defaults to '='.
    The special relop :null will be translated to " IS NULL" and :notnull translated to " IS NOT NULL". "like" will translated to " LIKE ". "notlike" will be translated to " NOT LIKE ".
    A leading + or - denotes an order by field. + means ascending, - means descending. Such a parameter must not be followed by operators.
    An optional leading entity name followed by a dot and the attribute denotes a so-called component-key. This is an attribute of a component of the current entity. The current entity must be a root-entity.
```
 Examples:
          poolId            -> name=poolId, arg=poolId, relop="="
          poolId[from]:>=   -> name=poolId, arg=from, relop=">="
          code:=:'Hurrz'    -> name=code, arg=code, relop="=", value="'Hurz'"
          code:=#'Hurrz'    -> name=code, arg=code, relop="=", value="'Hurz'", fixed=true

          +poolId -kurzname -> ORDER BY poolId ASC, kurzname DESC
 
```
    The <attribute-path> describes the path to the attribute and is of the following form:
    - <component-entity>.
      The entity name of one of the PDO's components. May be any component in the composite's hierarchy.
      Parameter example:
      InvoiceLine.amount
    - [<component-entity>].<relation>.[<component-entity>.]
      The relation to the entity of the attribute. If the relation is defined in a component of the PDO, the component defining the relation needs to be prepended.
      If the attribute is part of a component of the related entity, it's component needs to be appended to the relation.
      Parameter examples:
      InvoiceLine.Product.price
      .User.Address.zipCode
    - .
      For convenience, a leading dot is equivalent to an attribute-name without a dot.
      Parameter example:
      .poolId
    Parameters:
    
    text - the wurblet arg
- Method Detail
  - isComponentKey
```
public boolean isComponentKey()
```
    Returns whether this is a component key.
    
    Returns:
    
    true if component key
  - isRelationKey
```
public boolean isRelationKey()
```
    Returns whether this is a relation key.
    
    Returns:
    
    true if relation key
  - getComponentEntityName
```
public String getComponentEntityName()
```
    Gets the entity name of the component key.
    
    Returns:
    
    the entity, null if this is not a component key
  - getRelationComponentEntityName
```
public String getRelationComponentEntityName()
```
    Gets the component of the related entity pointed to by the relation key.
    
    Returns:
    
    the component, null if direct attribute of related entity
  - getRelationName
```
public String getRelationName()
```
    Gets the relation of the relation key.
    
    Returns:
    
    the relation
  - isSortKey
```
public boolean isSortKey()
```
    Returns true if this is a sorting parameter.
    
    Returns:
    
    true if sorting parameter
  - getSortMode
```
public String getSortMode()
```
    Returns the sortmode if !isKey().
    
    Returns:
    
    the sortmode, null if isKey
  - isArg
```
public boolean isArg()
```
    Returns:
    
    true if its a method parameter
  - isSqlArg
```
public boolean isSqlArg()
```
    Returns:
    
    true if we need an sql arg
  - getSqlArg
```
public String getSqlArg()
```
    Returns:
    
    the sql argument or the value
  - getRelop
```
public String getRelop()
```
    Gets the relop string.
    Usually "=?" or " IS NULL" or "=value"
    
    Returns:
    
    the relop string
  - getText
```
public String getText()
```
    Gets the original text.
    
    Returns:
    
    the text
  - getName
```
public String getName()
```
    name of the database attribute.
    
    Returns:
    
    the name
  - setName
```
public void setName(String name)
```
    name of the database attribute.
    
    Parameters:
    
    name - the name to set
  - getArg
```
public String getArg()
```
    name of the method argument.
    
    Returns:
    
    the arg
  - setArg
```
public void setArg(String arg)
```
    name of the method argument.
    
    Parameters:
    
    arg - the arg to set
  - setRelop
```
public void setRelop(String relop)
```
    relational operator.
    
    Parameters:
    
    relop - the relop to set
  - getValue
```
public String getValue()
```
    predefined value (replaces the ?).
    
    Returns:
    
    the value
  - setValue
```
public void setValue(String value)
```
    predefined value (replaces the ?).
    
    Parameters:
    
    value - the value to set
  - isFixed
```
public boolean isFixed()
```
    fixed value (directly put into sql-statement).
    
    Returns:
    
    the fixed
  - setFixed
```
public void setFixed(boolean fixed)
```
    fixed value (directly put into sql-statement).
    
    Parameters:
    
    fixed - the fixed to set
  - getAttribute
```
public Attribute getAttribute()
```
    the model attribute.
    
    Returns:
    
    the attribute
  - setAttribute
```
public void setAttribute(Attribute attribute)
```
    the model attribute.
    
    Parameters:
    
    attribute - the attribute to set
  - getRelation
```
public Relation getRelation()
```
    Gets the relation if this is a relation key.
    
    Returns:
    
    the relation
  - setRelation
```
public void setRelation(Relation relation)
```
    Sets the relation if this is a relation key.
    
    Parameters:
    
    relation - the relation
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class WurbletParameter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WurbletParameter

Method Detail

isComponentKey

isRelationKey

getComponentEntityName

getRelationComponentEntityName

getRelationName

isSortKey

getSortMode

isArg

isSqlArg

getSqlArg

getRelop

getText

getName

setName

getArg

setArg

setRelop

getValue

setValue

isFixed

setFixed

getAttribute

setAttribute

getRelation

setRelation

toString