Skip navigation links

oracle.javatools.db.sql
Interface SQLFragment

All Superinterfaces:

ChildDBObject, Copyable, DBObject, DynamicPropertySet

All Known Subinterfaces:

AliasFragment, DBObjectUsage, DeclarativeSQLQuery, FromObjectUsage, JoinCondition, SQLQuery

All Known Implementing Classes:

AbstractAliasFragment, AbstractDBObjectUsage, AbstractFromObjectUsage, AbstractSchemaObjectUsage, AbstractSQLFragment, AbstractSQLQuery, ArithmeticOperation, AsteriskUsage, CaseStatement, CaseStatement.WhenThen, ColumnKeywordUsage, ColumnUsage, Comparison, DataMiningFunction, DataMiningFunction.DataMiningArguments, DataMiningFunction.DataMiningCostValues, ExpressionList, FKUsage, FromObject, Function, FunctionUsage, GroupByExpression, GroupByObject, HierarchicalQueryObject, IndexObject, JoinObject, ModelObject, ModelObject.CellAssignment, ModelObject.CellReferenceOptions, ModelObject.ModelColumnClauses, ModelObject.ModelRulesCellAssignmentExpr, ModelObject.ModelRulesClause, ModelObject.MultiColumnForLoop, ModelObject.ReferenceModel, ModelObject.SingleColumnForLoop, NonDeclarativeSQLQuery, OnJoinCondition, Operation, OracleSQLQuery, OrderByObject, PlSqlUsage, RelationUsage, SelectObject, SelectObjectUsage, SetOperation, SetOperator, SimpleSQLFragment, SynonymUsage, UsingJoinCondition, WhereObject, WindowFunction, WindowFunction.WindowFunctionBound

public interface SQLFragment

extends ChildDBObject

Interface for objects that encapsulate a fragment of SQL. These fragments should contain no validation - all logic to do with the structure and validity of a SQLQuery and its fragments should be contained in the appropriate SQLQueryBuilder. This allows different database/object implementations easier to write, and make the SQLQuery itself more flexible.

The SQLFragment interface includes methods for getting and setting generic properties on a fragment (like DBObject). This is for users of the objects (e.g. SQLQueryBuilder, the Database Modeler etc).

Since:

10.1.3

Field Summary

static java.lang.String	CONNECTBY
static java.lang.String	FROM
static java.lang.String	GROUPBY
static java.lang.String	HAVING
static java.lang.String	MODEL
static java.lang.String	NOCYCLE
static java.lang.String	ORDERBY
static java.lang.String	ORDERSIBLINGSBY
static java.lang.String	PRIOR
static java.lang.String	SELECT
static java.lang.String	STARTWITH
static java.lang.String	TYPE
static java.lang.String	WHERE

Fields inherited from interface oracle.javatools.db.DBObject

COMMENT

Method Summary

java.lang.String	getSQLText() Return the SQL for this fragment.
java.lang.Integer	getStartOffset() If the position of the fragment of SQL within the overall SQL Statement is known, it will be returned here as an Integer zero based offset.

Methods inherited from interface oracle.javatools.db.ChildDBObject

getParent, setParent

Methods inherited from interface oracle.javatools.db.DBObject

copyTo, copyTo, copyTo, findOwnedObject, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getReferenceIDs, getType, replaceReferenceIDs, setID, setName

Methods inherited from interface oracle.javatools.util.DynamicPropertySet

getProperties, getProperty, getProperty, setProperties, setProperty

Field Detail

TYPE

static final java.lang.String TYPE

See Also:

Constant Field Values

SELECT

static final java.lang.String SELECT

See Also:

Constant Field Values

FROM

static final java.lang.String FROM

See Also:

Constant Field Values

WHERE

static final java.lang.String WHERE

See Also:

Constant Field Values

ORDERBY

static final java.lang.String ORDERBY

See Also:

Constant Field Values

ORDERSIBLINGSBY

static final java.lang.String ORDERSIBLINGSBY

See Also:

Constant Field Values

GROUPBY

static final java.lang.String GROUPBY

See Also:

Constant Field Values

HAVING

static final java.lang.String HAVING

See Also:

Constant Field Values

CONNECTBY

static final java.lang.String CONNECTBY

See Also:

Constant Field Values

PRIOR

static final java.lang.String PRIOR

See Also:

Constant Field Values

STARTWITH

static final java.lang.String STARTWITH

See Also:

Constant Field Values

NOCYCLE

static final java.lang.String NOCYCLE

See Also:

Constant Field Values

MODEL

static final java.lang.String MODEL

See Also:

Constant Field Values

Method Detail

getSQLText

java.lang.String getSQLText()

Return the SQL for this fragment. This contains no validation - if the implementation is incomplete it will just return what it has. Error checking of fragments should be done using a SQLQueryBuilder.

Returns:

a string representing the SQL text for this object.

getStartOffset

java.lang.Integer getStartOffset()

If the position of the fragment of SQL within the overall SQL Statement is known, it will be returned here as an Integer zero based offset. Can return null.

Returns:

The position of the fragment within the overall statement or null if not known

Skip navigation links