org.eclipse.datatools.modelbase.sql.xml.query
Interface XMLValueFunctionForest

All Superinterfaces:
org.eclipse.emf.ecore.EModelElement, org.eclipse.emf.ecore.ENamedElement, org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier, QueryValueExpression, SQLObject, SQLQueryObject, ValueExpression, ValueExpressionAtomic, ValueExpressionFunction, XMLValueFunction

public interface XMLValueFunctionForest
extends XMLValueFunction

A representation of the model object 'XML Value Function Forest'. Generates an XML value containing a sequence of XML elements. See ISO SQL/XML sec. 6.14.

The following features are supported:

See Also:
SQLXMLQueryModelPackage.getXMLValueFunctionForest()

Method Summary
 org.eclipse.emf.common.util.EList getForestContentList()
          Returns the value of the 'Forest Content List' containment reference list.
 XMLNamespacesDeclaration getNamespacesDecl()
          Returns the value of the 'Namespaces Decl' containment reference.
 XMLNullHandlingType getNullHandlingOption()
          Returns the value of the 'Null Handling Option' attribute.
 XMLReturningType getReturningOption()
          Returns the value of the 'Returning Option' attribute.
 void setNamespacesDecl(XMLNamespacesDeclaration value)
          Sets the value of the 'Namespaces Decl' containment reference.
 void setNullHandlingOption(XMLNullHandlingType value)
          Sets the value of the 'Null Handling Option' attribute.
 void setReturningOption(XMLReturningType value)
          Sets the value of the 'Returning Option' attribute.
 
Methods inherited from interface org.eclipse.datatools.modelbase.sql.query.ValueExpressionFunction
getFunction, getParameterList, isColumnFunction, isDistinct, isSpecialRegister, setColumnFunction, setDistinct, setFunction, setSpecialRegister
 
Methods inherited from interface org.eclipse.datatools.modelbase.sql.query.QueryValueExpression
getBasicLeft, getBasicRight, getBetweenLeft, getBetweenRight1, getBetweenRight2, getCallStatement, getDataType, getGroupingExpr, getInValueListLeft, getInValueListRight, getInValueRowSelectLeft, getInValueSelectLeft, getLikeEscape, getLikeMatching, getLikePattern, getNest, getOrderByValueExpr, getPredicateNull, getQuantifiedRowSelectLeft, getQuantifiedValueSelectLeft, getResultColumn, getTableFunction, getUnaryOperator, getUpdateSourceExprList, getValueExprCaseElse, getValueExprCaseSearchContent, getValueExprCaseSimple, getValueExprCaseSimpleContentResult, getValueExprCaseSimpleContentWhen, getValueExprCast, getValueExprCombinedLeft, getValueExprCombinedRight, getValueExprFunction, getValueExprLabeledDuration, getValueExprRow, getValuesRow, setBasicLeft, setBasicRight, setBetweenLeft, setBetweenRight1, setBetweenRight2, setCallStatement, setDataType, setGroupingExpr, setInValueListLeft, setInValueListRight, setInValueRowSelectLeft, setInValueSelectLeft, setLikeEscape, setLikeMatching, setLikePattern, setNest, setOrderByValueExpr, setPredicateNull, setQuantifiedRowSelectLeft, setQuantifiedValueSelectLeft, setResultColumn, setTableFunction, setUnaryOperator, setUpdateSourceExprList, setValueExprCaseElse, setValueExprCaseSearchContent, setValueExprCaseSimple, setValueExprCaseSimpleContentResult, setValueExprCaseSimpleContentWhen, setValueExprCast, setValueExprCombinedLeft, setValueExprCombinedRight, setValueExprFunction, setValueExprLabeledDuration, setValueExprRow, setValuesRow
 
Methods inherited from interface org.eclipse.datatools.modelbase.sql.query.SQLQueryObject
getSourceInfo, getSQL, setSourceInfo, setSQL
 
Methods inherited from interface org.eclipse.datatools.modelbase.sql.schema.SQLObject
addEAnnotation, addEAnnotationDetail, getComments, getDependencies, getDescription, getEAnnotation, getEAnnotationDetail, getExtensions, getLabel, getPrivileges, removeEAnnotationDetail, setAnnotationDetail, setDescription, setLabel
 
Methods inherited from interface org.eclipse.emf.ecore.ENamedElement
getName, setName
 
Methods inherited from interface org.eclipse.emf.ecore.EModelElement
getEAnnotations
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 
Methods inherited from interface org.eclipse.datatools.modelbase.sql.expressions.ValueExpression
getSQL, setSQL
 

Method Detail

getNullHandlingOption

XMLNullHandlingType getNullHandlingOption()
Returns the value of the 'Null Handling Option' attribute. The literals are from the enumeration XMLNullHandlingType.

If the meaning of the 'Null Handling Option' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Null Handling Option' attribute.
See Also:
XMLNullHandlingType, setNullHandlingOption(XMLNullHandlingType), SQLXMLQueryModelPackage.getXMLValueFunctionForest_NullHandlingOption()

setNullHandlingOption

void setNullHandlingOption(XMLNullHandlingType value)
Sets the value of the 'Null Handling Option' attribute.

Parameters:
value - the new value of the 'Null Handling Option' attribute.
See Also:
XMLNullHandlingType, getNullHandlingOption()

getReturningOption

XMLReturningType getReturningOption()
Returns the value of the 'Returning Option' attribute. The literals are from the enumeration XMLReturningType.

If the meaning of the 'Returning Option' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Returning Option' attribute.
See Also:
XMLReturningType, setReturningOption(XMLReturningType), SQLXMLQueryModelPackage.getXMLValueFunctionForest_ReturningOption()

setReturningOption

void setReturningOption(XMLReturningType value)
Sets the value of the 'Returning Option' attribute.

Parameters:
value - the new value of the 'Returning Option' attribute.
See Also:
XMLReturningType, getReturningOption()

getForestContentList

org.eclipse.emf.common.util.EList getForestContentList()
Returns the value of the 'Forest Content List' containment reference list. The list contents are of type XMLValueFunctionForestContentItem. It is bidirectional and its opposite is 'Value Function Forest'.

If the meaning of the 'Forest Content List' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Forest Content List' containment reference list.
See Also:
SQLXMLQueryModelPackage.getXMLValueFunctionForest_ForestContentList(), XMLValueFunctionForestContentItem.getValueFunctionForest()

getNamespacesDecl

XMLNamespacesDeclaration getNamespacesDecl()
Returns the value of the 'Namespaces Decl' containment reference. It is bidirectional and its opposite is 'Value Function Forest'.

If the meaning of the 'Namespaces Decl' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Namespaces Decl' containment reference.
See Also:
setNamespacesDecl(XMLNamespacesDeclaration), SQLXMLQueryModelPackage.getXMLValueFunctionForest_NamespacesDecl(), XMLNamespacesDeclaration.getValueFunctionForest()

setNamespacesDecl

void setNamespacesDecl(XMLNamespacesDeclaration value)
Sets the value of the 'Namespaces Decl' containment reference.

Parameters:
value - the new value of the 'Namespaces Decl' containment reference.
See Also:
getNamespacesDecl()