com.redhat.rhn.common.db.datasource

Interface ParsedQuery

public interface ParsedQuery

The DataSourceParserHelper creates an instance of this ParsedQuery for each query it parses. The ParsedQuery is used by ModeFactory when creating new Mode objects and the elaborators and queries contained therein.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAlias() Get the query's alias.
java.lang.String	getElaboratorJoinColumn() Get the elaborator join column.
java.lang.String	getName() Get the name of the query.
java.util.List<java.lang.String>	getParameterList() Get the list of parameters required by this query.
java.lang.String	getSqlStatement() Get the sql statement as defined in the mode query xml definition file.
boolean	isMultiple() Determine if this elaborator can return multiple values for each item in the primary query.

Method Detail

getName

java.lang.String getName()

Get the name of the query.

Returns:

name of the query.

getAlias

java.lang.String getAlias()

Get the query's alias.

Returns:

the query's alias.

getSqlStatement

java.lang.String getSqlStatement()

Get the sql statement as defined in the mode query xml definition file.

Returns:

the sql statement.

getElaboratorJoinColumn

java.lang.String getElaboratorJoinColumn()

Get the elaborator join column. NOTE: This value may not be used in anything but unit tests as I only find case where this value is defined outside of test_queries.xml and that is in scap_queries.xml for a query named "testresult_counts".

Returns:

the elaborator join column

getParameterList

java.util.List<java.lang.String> getParameterList()

Get the list of parameters required by this query.

Returns:

The list of parameters for this query.

isMultiple

boolean isMultiple()

Determine if this elaborator can return multiple values for each item in the primary query.

Returns:

True if this elaborator can return multiple for each item in the primary query, false otherwise.