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
- Version:
- $Id: //open/mondrian/src/main/mondrian/olap/fun/ResolverBase.java#13 $
- Author:
- jhyde
Constructor Summary |
ResolverBase(java.lang.String name,
java.lang.String signature,
java.lang.String description,
Syntax syntax)
|
Method Summary |
java.lang.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. |
java.lang.String |
getName()
Returns the name of the function or operator. |
java.lang.String[] |
getReservedWords()
Returns an array of symbolic constants which can appear as arguments
to this function. |
java.lang.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, box, box, checkCompatible, checkFlag, checkIterListResultStyles, checkListResultStyles, compareHierarchically, compareSiblingMembers, compareValues, compareValues, compareValues, correlation, count, cousin, covariance, createDummyFunDef, decodeCategory, decodeParameterCategories, decodeReturnCategory, decodeSyntacticType, dimensionMembers, equalTuple, evaluateMembers, evaluateSet, evaluateSet, evaluateTuples, getDimensionDefaultHierarchy, getLiteralArg, getLiteralArg, getNonEmptyLevelMembers, getNonEmptyMemberChildren, hierarchizeMemberList, hierarchizeTupleList, hierarchyMembers, isAncestorOf, isMemberType, levelMembers, makeNullMember, makeNullTuple, max, memberRange, min, newEvalException, newEvalException, partiallySortMembers, partiallySortTuples, partialSort, percentile, periodsToDate, quartile, removeCalculatedMembers, resolveFunArgs, searchValuesDesc, sign, sortMembers, sortMembers, sortTuples, sortTuples, sortValuesDesc, stablePartialSort, stdev, sum, sumDouble, sumDouble, toPercent, tupleContainsNullMember, var |
Methods inherited from class mondrian.olap.Util |
addDatabaseTime, addLevelCalculatedMembers, append, appendArrays, areOccurencesEqual, assertPostcondition, assertPostcondition, assertPrecondition, assertPrecondition, assertTrue, assertTrue, badValue, camelToUpper, caseSensitiveCompareName, cast, cast, castToIterable, checkCJResultLimit, commaList, compareKey, compareName, convertStackToString, createExpr, createRandom, createSimpleValidator, createUdf, dbTimeMillis, deprecated, enumSetAllOf, enumSetNoneOf, enumSetOf, equal, equalArray, equalName, equals, equals, getAnnotation, getErrorMessage, getErrorMessage, getFirstDescendantOnLevel, getMemberOrdinalInParent, hash, hash, hashArray, implode, isBlank, isEmpty, isNull, isSorted, isValidProperty, lookup, 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, readVirtualFile, replace, replace, replaceProperties, singleQuoteString, singleQuoteString, toMap, toURL, unexpected, uniquify, unparse, unparse, wildcardToRegexp |
Methods inherited from class org.eigenbase.xom.XOMUtil |
addChild, addChild, addChildren, addElement, concatenate, createDefaultParser, discard, discard, discard, discard, discard, discard, discard, discard, discard, getFirstInstance, 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 |
ResolverBase
ResolverBase(java.lang.String name,
java.lang.String signature,
java.lang.String description,
Syntax syntax)
getName
public java.lang.String getName()
- Description copied from interface:
Resolver
- Returns the name of the function or operator.
- Specified by:
getName
in interface Resolver
getSignature
public java.lang.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 java.lang.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 k
th argument; true otherwise.
- Specified by:
requiresExpression
in interface Resolver
getReservedWords
public java.lang.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