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

All Superinterfaces:
QueryValueExpression, SQLObject, SQLQueryObject, ValueExpression, ValueExpressionAtomic, ValueExpressionFunction, XMLValueFunction
All Known Implementing Classes:
XMLValueFunctionPIImpl

public interface XMLValueFunctionPI
extends XMLValueFunction

A representation of the model object 'XML Value Function PI'. Generates an XML value consisting of an XML processing instruction based on the given string expression. See ISO SQL/XML sec. 6.16.

The following features are supported:

See Also:
SQLXMLQueryModelPackage.getXMLValueFunctionPI()

Method Summary
 XMLValueFunctionPIContent getPIContent()
          Returns the value of the 'PI Content' containment reference.
 XMLReturningType getReturningOption()
          Returns the value of the 'Returning Option' attribute.
 java.lang.String getTargetName()
          Returns the value of the 'Target Name' attribute.
 void setPIContent(XMLValueFunctionPIContent value)
          Sets the value of the 'PI Content' containment reference.
 void setReturningOption(XMLReturningType value)
          Sets the value of the 'Returning Option' attribute.
 void setTargetName(java.lang.String value)
          Sets the value of the 'Target Name' 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, getDataType, getGroupingExpr, getInValueListLeft, getInValueListRight, getInValueRowSelectLeft, getInValueSelectLeft, getLikeEscape, getLikeMatching, getLikePattern, getNest, getOrderByValueExpr, getPredicateNull, getQuantifiedRowSelectLeft, getQuantifiedValueSelectLeft, getResultColumn, getUnaryOperator, getUpdateSourceExprList, getValueExprCaseElse, getValueExprCaseSearchContent, getValueExprCaseSimple, getValueExprCaseSimpleContentResult, getValueExprCaseSimpleContentWhen, getValueExprCast, getValueExprCombinedLeft, getValueExprCombinedRight, getValueExprFunction, getValueExprLabeledDuration, getValuesRow, setBasicLeft, setBasicRight, setBetweenLeft, setBetweenRight1, setBetweenRight2, setDataType, setGroupingExpr, setInValueListLeft, setInValueListRight, setInValueRowSelectLeft, setInValueSelectLeft, setLikeEscape, setLikeMatching, setLikePattern, setNest, setOrderByValueExpr, setPredicateNull, setQuantifiedRowSelectLeft, setQuantifiedValueSelectLeft, setResultColumn, setUnaryOperator, setUpdateSourceExprList, setValueExprCaseElse, setValueExprCaseSearchContent, setValueExprCaseSimple, setValueExprCaseSimpleContentResult, setValueExprCaseSimpleContentWhen, setValueExprCast, setValueExprCombinedLeft, setValueExprCombinedRight, setValueExprFunction, setValueExprLabeledDuration, 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, getLabel, getPrivileges, removeEAnnotationDetail, setAnnotationDetail, setDescription, setLabel
 
Methods inherited from interface org.eclipse.datatools.modelbase.sql.expressions.ValueExpression
getSQL, setSQL
 

Method Detail

getTargetName

java.lang.String getTargetName()
Returns the value of the 'Target Name' attribute.

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

Returns:
the value of the 'Target Name' attribute.
See Also:
setTargetName(String), SQLXMLQueryModelPackage.getXMLValueFunctionPI_TargetName()

setTargetName

void setTargetName(java.lang.String value)
Sets the value of the 'Target Name' attribute.

Parameters:
value - the new value of the 'Target Name' attribute.
See Also:
getTargetName()

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.getXMLValueFunctionPI_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()

getPIContent

XMLValueFunctionPIContent getPIContent()
Returns the value of the 'PI Content' containment reference. It is bidirectional and its opposite is 'Value Function PI'.

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

Returns:
the value of the 'PI Content' containment reference.
See Also:
setPIContent(XMLValueFunctionPIContent), SQLXMLQueryModelPackage.getXMLValueFunctionPI_PIContent(), XMLValueFunctionPIContent.getValueFunctionPI()

setPIContent

void setPIContent(XMLValueFunctionPIContent value)
Sets the value of the 'PI Content' containment reference.

Parameters:
value - the new value of the 'PI Content' containment reference.
See Also:
getPIContent()


Copyright © 2006 -- 2008 Actuate, IBM Corporation, Sybase, Inc. and others. All rights reserved.