streams.SubscriptionExpression Class Reference

Class that represents a subscription expression clause for import specifications. More...

Classes
class	Kind
class	Literal
	Class that represents subscription expression literals. More...
class	Op

Public Member Functions
def	toString (self)
	Get the string representation of the subscription expression. More...
def	getSize (self)
	Return the number of subclauses in an and/or-clause. More...
def	getSubclause
def	getSubclause
def	addClause
def	removeClause
def	getKind (self)
	Get the kind of the subscription expression (and clause, or clause, or a predicate) More...
def	getSymbol (self)
	Return the symbol in a predicate clause. More...
def	getLiteral (self)
	Return the literal in a predicate. More...
def	getOp (self)
	Return the operator in an predicate clause. More...
def	hasSubscript (self)
	Return true if the symbol in a predicate clause has a subscript. More...
def	getSubscript (self)
	Return subscript for the symbol in a predicate clause. More...
def	hasModuloDivisor (self)
	Return true if the symbol in a predicate clause has a modulo divisor. More...
def	getModuloDivisor (self)
	Return modulo divisor for the symbol in a predicate clause. More...
def	isEmpty (self)
	Is this an empty SubscriptionExpression? More...

Static Public Member Functions
def	createPredicate
def	createModuloPredicate
def	createAndClause
def	createOrClause
def	fromString

Detailed Description

Class that represents a subscription expression clause for import specifications.

Member Function Documentation

toString()

def streams.SubscriptionExpression.toString	(		self,
			str
	)

Get the string representation of the subscription expression.

Returns

string representation of the subscription expression

getSize()

def streams.SubscriptionExpression.getSize	(		self,
			int
	)

Return the number of subclauses in an and/or-clause.

Precondition

getKind() != Predicate

Returns

number of subclauses in the clause

Exceptions

SPLRuntimeSubscriptionInvalidClauseException

if the subscription expression represents a predicate clause

getSubclause() [1/2]

def streams.SubscriptionExpression.getSubclause	(		self,
			index
	)

getSubclause() [2/2]

def streams.SubscriptionExpression.getSubclause	(		self,
			index
	)

addClause()

def streams.SubscriptionExpression.addClause	(		self,
			subclause
	)

removeClause()

def streams.SubscriptionExpression.removeClause	(		self,
			index
	)

getKind()

def streams.SubscriptionExpression.getKind	(		self,
			Kind
	)

Get the kind of the subscription expression (and clause, or clause, or a predicate)

Returns

kind of the subscription expression

getSymbol()

def streams.SubscriptionExpression.getSymbol	(		self,
			str
	)

Return the symbol in a predicate clause.

Precondition

getKind() == Predicate

Returns

symbol

Exceptions

SPLRuntimeSubscriptionInvalidClauseException

if the subscription expression does not represent a predicate clause

getLiteral()

def streams.SubscriptionExpression.getLiteral	(		self,
			Literal
	)

Return the literal in a predicate.

Precondition

getKind() == Predicate

Returns

literal

Exceptions

SPLRuntimeSubscriptionInvalidClauseException

if the subscription expression does not represent a predicate clause

getOp()

def streams.SubscriptionExpression.getOp	(		self,
			Op
	)

Return the operator in an predicate clause.

Precondition

getKind() == Predicate

Returns

operation

Exceptions

SPLRuntimeSubscriptionInvalidClauseException

if the subscription expression does not represent a predicate clause

hasSubscript()

def streams.SubscriptionExpression.hasSubscript	(		self,
			bool
	)

Return true if the symbol in a predicate clause has a subscript.

Precondition

getKind() == Predicate

Returns

true if the item has a subscript

Exceptions

SPLRuntimeSubscriptionInvalidClauseException

if the subscription expression does not represent a predicate clause

getSubscript()

def streams.SubscriptionExpression.getSubscript	(		self,
			int
	)

Return subscript for the symbol in a predicate clause.

Precondition

getKind() == Predicate && hasSubscript()

Returns

subscript value

Exceptions

SPLRuntimeSubscriptionInvalidClauseException

if the subscription expression does not represent a predicate clause or if it does not have a subscript

hasModuloDivisor()

def streams.SubscriptionExpression.hasModuloDivisor	(		self,
			bool
	)

Return true if the symbol in a predicate clause has a modulo divisor.

Precondition

getKind() == Predicate

Returns

true if the item has a modulo divisor

Exceptions

SPLRuntimeSubscriptionInvalidClauseException

if the subscription expression does not represent a predicate clause

getModuloDivisor()

def streams.SubscriptionExpression.getModuloDivisor	(		self,
			int
	)

Return modulo divisor for the symbol in a predicate clause.

Precondition

getKind() == Predicate && hasModuloDivisor()

Returns

modulo divisor value

Exceptions

SPLRuntimeSubscriptionInvalidClauseException

if the subscription expression does not represent a predicate clause or if it does not have a modulo divisor

isEmpty()

def streams.SubscriptionExpression.isEmpty	(		self,
			bool
	)

Is this an empty SubscriptionExpression?

Returns

true if the subscription expression represents an empty expression

createPredicate()

def streams.SubscriptionExpression.createPredicate (   symbol )

static

createModuloPredicate()

def streams.SubscriptionExpression.createModuloPredicate (   symbol )

static

createAndClause()

def streams.SubscriptionExpression.createAndClause (   subclause )

static

createOrClause()

def streams.SubscriptionExpression.createOrClause (   subclause )

static

fromString()

def streams.SubscriptionExpression.fromString (   str )

static

---

The documentation for this class was generated from the following file:

• streams/__init__.py