mondrian.olap.fun
Class ResolverBase

java.lang.Object
  org.eigenbase.xom.XMLUtil
      org.eigenbase.xom.XOMUtil
          mondrian.olap.Util
              mondrian.olap.fun.FunUtil
                  mondrian.olap.fun.ResolverBase

All Implemented Interfaces:

Resolver

Direct Known Subclasses:

CacheFunDef.CacheFunResolver

abstract class ResolverBase
extends FunUtil
implements Resolver

ResolverBase provides a skeleton implementation of interface Resolver

Since:

3 March, 2002

Author:

jhyde

Nested Class Summary

Nested classes/interfaces inherited from class mondrian.olap.fun.FunUtil

FunUtil.SetWrapper

Nested classes/interfaces inherited from class mondrian.olap.Util

Util.ErrorCellValue, Util.PropertyList

Field Summary

Fields inherited from class mondrian.olap.fun.FunUtil

BooleanNull, DoubleEmpty, DoubleNull, emptyStringArray, IntegerNull, NullMember

Fields inherited from class mondrian.olap.Util

EmptyValue, JdbcVersion, nl, nullValue, PreJdk15, Retrowoven

Constructor Summary

ResolverBase(String name, String signature, String description, Syntax syntax)

Method Summary

String	getDescription() Returns the description of the function or operator.
FunDef	getFunDef() Returns a representative example of the function which this Resolver can produce, for purposes of describing the function set.
String	getName() Returns the name of the function or operator.
String[]	getReservedWords() Returns an array of symbolic constants which can appear as arguments to this function.
String	getSignature() Returns a string describing the syntax of this function, for example
Syntax	getSyntax() Returns the syntax with which the function or operator was invoked.
boolean	requiresExpression(int k) Returns whether a particular argument must be a scalar expression.

Methods inherited from class mondrian.olap.fun.FunUtil

addMembers, addMembers, addUnique, ancestor, appendTuple, avg, checkCompatible, checkFlag, checkIterListResultStyles, checkListResultStyles, compareHierarchically, compareSiblingMembers, compareValues, compareValues, compareValues, correlation, count, cousin, covariance, createDummyFunDef, decodeCategory, decodeParameterCategories, decodeReturnCategory, decodeSyntacticType, dimensionMembers, equalTuple, evaluateMembers, evaluateMembers, evaluateSet, evaluateSet, evaluateTuples, getLiteralArg, getLiteralArg, getNonEmptyLevelMembers, getNonEmptyMemberChildren, hierarchize, hierarchyMembers, isAncestorOf, isMemberType, levelMembers, makeNullMember, makeNullTuple, max, memberRange, min, newEvalException, newEvalException, percentile, periodsToDate, quartile, removeCalculatedMembers, resolveFunArgs, searchValuesDesc, sign, sortMembers, sortTuples, sortValuesDesc, stdev, sum, sumDouble, sumDouble, toPercent, tupleContainsNullMember, var

Methods inherited from class mondrian.olap.Util

addDatabaseTime, addLevelCalculatedMembers, areOccurencesEqual, assertPostcondition, assertPostcondition, assertPrecondition, assertPrecondition, assertTrue, assertTrue, badValue, camelToUpper, caseSensitiveCompareName, cast, cast, checkCJResultLimit, commaList, compareKey, compareName, convertStackToString, createExpr, createRandom, createSimpleValidator, createUdf, dbTimeMillis, deprecated, enumSetAllOf, enumSetNoneOf, enumSetOf, equal, equalName, equals, equals, getAnnotation, getErrorMessage, getErrorMessage, getFirstDescendantOnLevel, getMemberOrdinalInParent, hash, hash, hashArray, implode, isEmpty, isNull, isSorted, isValidProperty, lookup, lookup, lookup, lookup, lookupCompound, lookupCompound, lookupHierarchyLevel, lookupHierarchyRootMember, lookupHierarchyRootMember, lookupProperty, makeBigDecimalFromDouble, makeFqName, makeFqName, makeFqName, maskVersion, mdxEncodeString, needToImplement, newError, newError, newInternal, newInternal, nonDbTimeMillis, normalizeName, parseCommaList, parseConnectString, parseIdentifier, printMemory, printMemory, quoteForMdx, quoteMdxIdentifier, quoteMdxIdentifier, quoteMdxIdentifier, quoteMdxIdentifier, quotePattern, readFully, readURL, readURL, readURL, readURL, replace, replace, replaceProperties, singleQuoteString, singleQuoteString, toMap, toURL, unexpected, union, union, uniquify, unparse, unparse, wildcardToRegexp

Methods inherited from class org.eigenbase.xom.XOMUtil

addAll, addAll, addChild, addChild, addChildren, addElement, concatenate, createDefaultParser, discard, discard, discard, discard, discard, discard, discard, discard, discard, getFirstInstance, toList, toVector, wrapperToXml

Methods inherited from class org.eigenbase.xom.XMLUtil

getFirstTagName, printAtt, printAtt, printAtt, printAtt, printPCDATA, printPCDATA, printPCDATA, quoteAtt, quoteAtt, quoteAtt, quoteAtt, quotePCDATA, stringEncodeXML, stringHasXMLSpecials

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface mondrian.olap.fun.Resolver

resolve

Constructor Detail

ResolverBase

ResolverBase(String name,
             String signature,
             String description,
             Syntax syntax)

Method Detail

getName

public String getName()

Description copied from interface: Resolver

Returns the name of the function or operator.

Specified by:

getName in interface Resolver

getSignature

public String getSignature()

Description copied from interface: Resolver

Returns a string describing the syntax of this function, for example

StrToSet()

Specified by:

getSignature in interface Resolver

getFunDef

public FunDef getFunDef()

Description copied from interface: Resolver

Returns a representative example of the function which this Resolver can produce, for purposes of describing the function set. May return null if there is no representative function, or if the Resolver has a way to describe itself in more detail.

Specified by:

getFunDef in interface Resolver

getDescription

public String getDescription()

Description copied from interface: Resolver

Returns the description of the function or operator.

Specified by:

getDescription in interface Resolver

getSyntax

public Syntax getSyntax()

Description copied from interface: Resolver

Returns the syntax with which the function or operator was invoked.

Specified by:

getSyntax in interface Resolver

requiresExpression

public boolean requiresExpression(int k)

Description copied from interface: Resolver

Returns whether a particular argument must be a scalar expression. Returns false if any of the variants of this resolver allows a set as its kth argument; true otherwise.

Specified by:

requiresExpression in interface Resolver

getReservedWords

public String[] getReservedWords()

Description copied from interface: Resolver

Returns an array of symbolic constants which can appear as arguments to this function.

For example, the DrilldownMember may take the symbol RECURSIVE as an argument. Most functions do not define any symbolic constants.

Specified by:

getReservedWords in interface Resolver

Returns:

An array of the names of the symbolic constants