|
Hyperic HQ Plugin API v. 4.4.0.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Critter
A Critter
is a criteria, able to aid in composing complex SQL.
Method Summary | |
---|---|
void |
bindSqlParams(CritterTranslationContext ctx,
org.hibernate.Query q)
Bind any SQL parameters which were previously returned as part of getSql(). |
java.lang.String |
getConfig()
Returns a localized description of how the Critter is configured. |
CritterType |
getCritterType()
Returns the CritterType associated with this Critter |
java.util.List |
getProps()
Get a list of CritterProps s which are the current
values set for this critter. |
java.lang.String |
getSql(CritterTranslationContext ctx,
java.lang.String resourceAlias)
Get a SQL segment, suitable for placement within a where clause. |
java.lang.String |
getSqlJoins(CritterTranslationContext ctx,
java.lang.String resourceAlias)
Get additional SQL specifying joins requierd by the critter The result of this method is run through CritterTranslationContext.escapeSql(String) which will
turn all references delimited by '@' into unique identifiers. |
Method Detail |
---|
java.util.List getProps()
CritterProps
s which are the current
values set for this critter.
java.lang.String getSql(CritterTranslationContext ctx, java.lang.String resourceAlias)
CritterTranslationContext.escapeSql(String)
, which will
turn all references delimited '@' into unique identifiers.
resourceAlias
- The SQL alias for the Resource
java.lang.String getSqlJoins(CritterTranslationContext ctx, java.lang.String resourceAlias)
CritterTranslationContext.escapeSql(String)
which will
turn all references delimited by '@' into unique identifiers.
void bindSqlParams(CritterTranslationContext ctx, org.hibernate.Query q)
CritterTranslationContext.escape(String)
to bind to variables
which match the references returned from getSql, etc.
CritterType getCritterType()
CritterType
associated with this Critter
java.lang.String getConfig()
|
Hyperic HQ Plugin API v. 4.4.0.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |