public abstract class FunctionImpl extends RelationalObjectImpl implements Function
Function.Determinism
AbstractProcedure.Utils
RelationalObject.Filter
SchemaElement.SchemaElementType
Modifier and Type | Field and Description |
---|---|
protected static KomodoType[] |
CHILD_TYPES
The allowed child types.
|
LOGGER, VALIDATE_INITIAL_STATE
index, path
DEFAULT_AGGREGATE, DEFAULT_ALLOWS_DISTINCT, DEFAULT_ALLOWS_ORDER_BY, DEFAULT_ANALYTIC, DEFAULT_DECOMPOSABLE, DEFAULT_NULL_ON_NULL, DEFAULT_USES_DISTINCT_ROWS, DEFAULT_VARARGS, NO_FUNCTIONS
DEFAULT_UPDATE_COUNT
DDL_QNAMES_FILTER, DEFAULT_FILTERS, JCR_FILTER, NO_FILTERS, NT_FILTER, RESIDUAL_FILTER
EMPTY_ARRAY
AMPERSAND, AT, BR, CLASS, CLOSE_ANGLE_BRACKET, CLOSE_BRACE, CLOSE_BRACKET, CLOSE_PRE_CMT, CLOSE_PRE_TAG, CLOSE_SQUARE_BRACKET, COLON, COMMA, CONNECTION_SUFFIX, CURRENT_FOLDER_SYMBOL, DDL, DEFAULT_LOCAL_WORKSPACE_NAME, DIVIDE, DOLLAR_SIGN, DOT, DOT_CHAR, DOT_DOT, DOT_KOMODO, DOUBLE_BACK_SLASH, DRIVE_SEPARATOR, EMPTY_ARRAY, EMPTY_STRING, ENUM, EQUALS, FILE_EXTENSION_SEPARATOR, FILE_NAME_WILDCARD, FINAL, FORWARD_SLASH, HASH, HYPHEN, INTERFACE, JAR, JAVA, JAVA_IO_TMPDIR, JBOSS_SERVER_TMP_DIR, KOMODO, LINE_SEPARATOR, LINE_SEPARATOR_PROPERTY_NAME, LOG, MINUS, MULTIPLY, NBSP, NEW_LINE, OPEN_ANGLE_BRACKET, OPEN_BRACE, OPEN_BRACKET, OPEN_PRE_CMT, OPEN_PRE_TAG, OPEN_SQUARE_BRACKET, PARENT_FOLDER_SYMBOL, PERCENT, PIPE, PLUS, PREFIX_PATTERN, PRIVATE, PUBLIC, QUESTION_MARK, QUOTE_MARK, SEMI_COLON, SERVICE_VDB_SUFFIX, SERVICE_VDB_VIEW_MODEL, SERVICE_VDB_VIEW_SUFFIX, SOURCES, SPACE, SPEECH_MARK, SRC, STAR, STATIC, TAB, TARGET, UNDERSCORE, UNDERSCORE_CHAR, VDB_DEPLOYMENT_SUFFIX, VDB_PREFIX, XML, XML_SUFFIX, ZIP, ZIP_SUFFIX
Modifier | Constructor and Description |
---|---|
protected |
FunctionImpl(Repository.UnitOfWork uow,
Repository repository,
String workspacePath) |
getChild, getChild, getChildrenOfType, getDescriptor, getDescriptors, getFilters, getPropertyDescriptors, hasChild, hasChild, hasChildren, hasDescriptor, isChildRestricted, removeDescriptor, resolveType, setFilters, setPrimaryType, toString, validateInitialState
accept, addChild, addDescriptor, equals, getAbsolutePath, getAllDescriptors, getIndex, getName, getObjectFactory, getObjectProperty, getPropertyFactory, getRawChildren, getRawDescriptors, getRawParent, getRawProperty, getRawPropertyDescriptors, getRawPropertyNames, getRepository, getTypeId, getTypeIdentifier, handleError, hashCode, hasRawChild, hasRawChild, hasRawChildren, hasRawProperty, print, provision, remove, removeChild, rename, setObjectProperty, validatePropertyValue, validateType
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
addParameter, getDescription, getNameInSource, getParameters, getParent, getUpdateCount, getUuid, removeParameter, setDescription, setNameInSource, setUpdateCount, setUuid
getStatementOptionNames, getStatementOptions, isCustomOption, removeStatementOption, setStatementOption
getFilters, setFilters
accept, addChild, addDescriptor, getChild, getChild, getChildren, getChildrenOfType, getChildTypes, getDescriptor, getDescriptors, getIndex, getObjectFactory, getPrimaryType, getProperty, getPropertyDescriptor, getPropertyDescriptors, getPropertyFactory, getPropertyNames, getRawChildren, getRawDescriptors, getRawParent, getRawProperty, getRawPropertyDescriptors, getRawPropertyNames, getTypeId, getTypeIdentifier, hasChild, hasChild, hasChildren, hasDescriptor, hasProperties, hasProperty, hasRawChild, hasRawChild, hasRawChildren, hasRawProperty, isChildRestricted, print, remove, removeChild, removeDescriptor, rename, setPrimaryType, setProperty
getAbsolutePath, getName, getRepository
getSchemaElementType, setSchemaElementType
protected static final KomodoType[] CHILD_TYPES
protected FunctionImpl(Repository.UnitOfWork uow, Repository repository, String workspacePath) throws KException
uow
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)repository
- the repository where the relational object exists (cannot be null
)workspacePath
- the workspace relative path (cannot be empty)KException
- if an error occurs or if node at specified path is not a procedurepublic StatementOption[] getCustomOptions(Repository.UnitOfWork transaction) throws KException
getCustomOptions
in interface OptionContainer
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)null
but can be empty)KException
- if an error occursOptionContainer.getCustomOptions(org.komodo.spi.repository.Repository.UnitOfWork)
public Function.Determinism getDeterminism(Repository.UnitOfWork transaction) throws KException
getDeterminism
in interface Function
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)determinism
property (can be empty)KException
- if an error occursFunction.getDeterminism(org.komodo.spi.repository.Repository.UnitOfWork)
public Map<String,String> getStandardOptions()
getStandardOptions
in interface OptionContainer
null
but can be empty)OptionContainer.getStandardOptions()
public boolean isAggregate(Repository.UnitOfWork transaction) throws KException
isAggregate
in interface Function
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)true
if the function is an aggregateKException
- if an error occursFunction.isAggregate(org.komodo.spi.repository.Repository.UnitOfWork)
public boolean isAllowsDistinct(Repository.UnitOfWork transaction) throws KException
isAllowsDistinct
in interface Function
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)true
if the function allows the DISTINCT keywordKException
- if an error occursFunction.isAllowsDistinct(org.komodo.spi.repository.Repository.UnitOfWork)
public boolean isAllowsOrderBy(Repository.UnitOfWork transaction) throws KException
isAllowsOrderBy
in interface Function
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)true
if the function supports the ORDER BY clauseKException
- if an error occursFunction.isAllowsOrderBy(org.komodo.spi.repository.Repository.UnitOfWork)
public boolean isAnalytic(Repository.UnitOfWork transaction) throws KException
isAnalytic
in interface Function
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)true
if the function is analyticKException
- if an error occursFunction.isAnalytic(org.komodo.spi.repository.Repository.UnitOfWork)
public boolean isDecomposable(Repository.UnitOfWork transaction) throws KException
isDecomposable
in interface Function
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)true
if the function is decomposableKException
- if an error occursFunction.isDecomposable(org.komodo.spi.repository.Repository.UnitOfWork)
public boolean isNullOnNull(Repository.UnitOfWork transaction) throws KException
isNullOnNull
in interface Function
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)true
if the function is called when any of its parameters is null
KException
- if an error occursFunction.isNullOnNull(org.komodo.spi.repository.Repository.UnitOfWork)
public boolean isStandardOption(String name)
isStandardOption
in interface OptionContainer
name
- the name of the option being checked (cannot be empty)true
if a standard optionOptionContainer.isStandardOption(java.lang.String)
public boolean isUsesDistinctRows(Repository.UnitOfWork transaction) throws KException
isUsesDistinctRows
in interface Function
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)true
if the function uses distinct rowsKException
- if an error occursFunction.isUsesDistinctRows(org.komodo.spi.repository.Repository.UnitOfWork)
public boolean isVarArgs(Repository.UnitOfWork transaction) throws KException
isVarArgs
in interface Function
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)true
if the function has variable argumentsKException
- if an error occursFunction.isVarArgs(org.komodo.spi.repository.Repository.UnitOfWork)
public void setAggregate(Repository.UnitOfWork transaction, boolean newAggregate) throws KException
setAggregate
in interface Function
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newAggregate
- the new value for the aggregate
propertyKException
- if an error occursFunction.setAggregate(org.komodo.spi.repository.Repository.UnitOfWork, boolean)
public void setAllowsDistinct(Repository.UnitOfWork transaction, boolean newAllowsDistinct) throws KException
setAllowsDistinct
in interface Function
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newAllowsDistinct
- the new value for the allows distinct
propertyKException
- if an error occursFunction.setAllowsDistinct(org.komodo.spi.repository.Repository.UnitOfWork, boolean)
public void setAllowsOrderBy(Repository.UnitOfWork transaction, boolean newAllowsOrderBy) throws KException
setAllowsOrderBy
in interface Function
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newAllowsOrderBy
- the new value for the allows order by
propertyKException
- if an error occursFunction.setAllowsOrderBy(org.komodo.spi.repository.Repository.UnitOfWork, boolean)
public void setAnalytic(Repository.UnitOfWork transaction, boolean newIsAnalytic) throws KException
setAnalytic
in interface Function
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newIsAnalytic
- the new value for the analytic
propertyKException
- if an error occursFunction.setAnalytic(org.komodo.spi.repository.Repository.UnitOfWork, boolean)
public void setDecomposable(Repository.UnitOfWork transaction, boolean newDecomposable) throws KException
setDecomposable
in interface Function
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newDecomposable
- the new value for the decomposable
propertyKException
- if an error occursFunction.setDecomposable(org.komodo.spi.repository.Repository.UnitOfWork, boolean)
public void setDeterminism(Repository.UnitOfWork transaction, Function.Determinism newDeterminism) throws KException
setDeterminism
in interface Function
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newDeterminism
- the new value for the determinism
propertyKException
- if an error occursFunction.setDeterminism(org.komodo.spi.repository.Repository.UnitOfWork,
org.komodo.relational.model.Function.Determinism)
public void setNullOnNull(Repository.UnitOfWork transaction, boolean newNullOnNull) throws KException
setNullOnNull
in interface Function
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newNullOnNull
- the new value for the null on null
propertyKException
- if an error occursFunction.setNullOnNull(org.komodo.spi.repository.Repository.UnitOfWork, boolean)
public void setUsesDistinctRows(Repository.UnitOfWork transaction, boolean newUsesDistinctRows) throws KException
setUsesDistinctRows
in interface Function
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newUsesDistinctRows
- the new value for the uses distinct rows
propertyKException
- if an error occursFunction.setUsesDistinctRows(org.komodo.spi.repository.Repository.UnitOfWork, boolean)
public void setVarArgs(Repository.UnitOfWork transaction, boolean newVarArgs) throws KException
setVarArgs
in interface Function
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newVarArgs
- the new value for the variable arguments
propertyKException
- if an error occursFunction.setVarArgs(org.komodo.spi.repository.Repository.UnitOfWork, boolean)
public Parameter addParameter(Repository.UnitOfWork transaction, String parameterName) throws KException
addParameter
in interface AbstractProcedure
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)parameterName
- the name of the parameter being added (cannot be null
)null
)KException
- if an error occursAbstractProcedure.addParameter(org.komodo.spi.repository.Repository.UnitOfWork,
java.lang.String)
public KomodoObject[] getChildren(Repository.UnitOfWork transaction, String... namePatterns) throws KException
getChildren
in interface KomodoObject
getChildren
in class RelationalObjectImpl
KException
RelationalObjectImpl.getChildren(org.komodo.spi.repository.Repository.UnitOfWork,
java.lang.String[])
public KomodoType[] getChildTypes()
getChildTypes
in interface KomodoObject
getChildTypes
in class ObjectImpl
ObjectImpl.getChildTypes()
public String getDescription(Repository.UnitOfWork transaction) throws KException
getDescription
in interface AbstractProcedure
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)annotation
option (can be empty)KException
- if an error occursAbstractProcedure.getDescription(org.komodo.spi.repository.Repository.UnitOfWork)
public String getNameInSource(Repository.UnitOfWork transaction) throws KException
getNameInSource
in interface AbstractProcedure
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)name in source
option (can be empty)KException
- if an error occursAbstractProcedure.getNameInSource(org.komodo.spi.repository.Repository.UnitOfWork)
public Parameter[] getParameters(Repository.UnitOfWork transaction, String... namePatterns) throws KException
getParameters
in interface AbstractProcedure
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)namePatterns
- optional name patterns of the child(ren) being requested (can be null
or empty but cannot have
null
or empty elements)null
but can be empty)KException
- if an error occursAbstractProcedure.getParameters(org.komodo.spi.repository.Repository.UnitOfWork,
java.lang.String[])
public Model getParent(Repository.UnitOfWork transaction) throws KException
getParent
in interface AbstractProcedure
getParent
in interface KNode
getParent
in class RelationalObjectImpl
KException
ObjectImpl.getParent(org.komodo.spi.repository.Repository.UnitOfWork)
public Descriptor getPrimaryType(Repository.UnitOfWork transaction) throws KException
getPrimaryType
in interface KomodoObject
getPrimaryType
in class ObjectImpl
KException
ObjectImpl.getPrimaryType(org.komodo.spi.repository.Repository.UnitOfWork)
public Property getProperty(Repository.UnitOfWork transaction, String name) throws KException
getProperty
in interface KomodoObject
getProperty
in class RelationalObjectImpl
KException
RelationalObjectImpl.getProperty(org.komodo.spi.repository.Repository.UnitOfWork,
java.lang.String)
public PropertyDescriptor getPropertyDescriptor(Repository.UnitOfWork transaction, String propName) throws KException
getPropertyDescriptor
in interface KomodoObject
getPropertyDescriptor
in class RelationalObjectImpl
KException
RelationalObjectImpl.getPropertyDescriptor(org.komodo.spi.repository.Repository.UnitOfWork,
java.lang.String)
public String[] getPropertyNames(Repository.UnitOfWork transaction) throws KException
getPropertyNames
in interface KomodoObject
getPropertyNames
in class RelationalObjectImpl
KException
RelationalObjectImpl.getPropertyNames(org.komodo.spi.repository.Repository.UnitOfWork)
public SchemaElement.SchemaElementType getSchemaElementType(Repository.UnitOfWork uow) throws KException
getSchemaElementType
in interface SchemaElement
uow
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)null
)KException
- if an error occursSchemaElement.getSchemaElementType(org.komodo.spi.repository.Repository.UnitOfWork)
public String[] getStatementOptionNames(Repository.UnitOfWork transaction) throws KException
getStatementOptionNames
in interface OptionContainer
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
))null
but can be empty)KException
- if an error occursOptionContainer.getStatementOptionNames(org.komodo.spi.repository.Repository.UnitOfWork)
public StatementOption[] getStatementOptions(Repository.UnitOfWork transaction) throws KException
getStatementOptions
in interface OptionContainer
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)null
but can be empty)KException
- if an error occursOptionContainer.getStatementOptions(org.komodo.spi.repository.Repository.UnitOfWork)
public int getUpdateCount(Repository.UnitOfWork transaction) throws KException
getUpdateCount
in interface AbstractProcedure
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)update count
optionKException
- if an error occursAbstractProcedure.getUpdateCount(org.komodo.spi.repository.Repository.UnitOfWork)
public String getUuid(Repository.UnitOfWork transaction) throws KException
getUuid
in interface AbstractProcedure
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)UUID
option (can be empty)KException
- if an error occursAbstractProcedure.getUuid(org.komodo.spi.repository.Repository.UnitOfWork)
public boolean hasProperties(Repository.UnitOfWork transaction) throws KException
hasProperties
in interface KomodoObject
hasProperties
in class ObjectImpl
KException
ObjectImpl.hasProperties(org.komodo.spi.repository.Repository.UnitOfWork)
public boolean hasProperty(Repository.UnitOfWork transaction, String name) throws KException
hasProperty
in interface KomodoObject
hasProperty
in class RelationalObjectImpl
KException
RelationalObjectImpl.hasProperty(org.komodo.spi.repository.Repository.UnitOfWork,
java.lang.String)
public boolean isCustomOption(Repository.UnitOfWork transaction, String name) throws KException
isCustomOption
in interface OptionContainer
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)name
- the name of the option being checked (cannot be empty)true
if the custom option existsKException
- if an error occursOptionContainer.isCustomOption(org.komodo.spi.repository.Repository.UnitOfWork,
java.lang.String)
public void removeParameter(Repository.UnitOfWork transaction, String parameterName) throws KException
removeParameter
in interface AbstractProcedure
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)parameterName
- the name of the parameter to remove (cannot be empty)KException
- if an error occursAbstractProcedure.removeParameter(org.komodo.spi.repository.Repository.UnitOfWork,
java.lang.String)
public void removeStatementOption(Repository.UnitOfWork transaction, String optionToRemove) throws KException
removeStatementOption
in interface OptionContainer
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)optionToRemove
- the name of the statement option being removed (cannot be empty)KException
- if an error occursOptionContainer.removeStatementOption(org.komodo.spi.repository.Repository.UnitOfWork,
java.lang.String)
public void setDescription(Repository.UnitOfWork transaction, String newDescription) throws KException
setDescription
in interface AbstractProcedure
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newDescription
- the new value of the annotation
option (can only be empty when removing)KException
- if an error occursAbstractProcedure.setDescription(org.komodo.spi.repository.Repository.UnitOfWork,
java.lang.String)
public void setNameInSource(Repository.UnitOfWork transaction, String newNameInSource) throws KException
setNameInSource
in interface AbstractProcedure
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newNameInSource
- the new name in source option (can only be empty when removing)KException
- if an error occursAbstractProcedure.setNameInSource(org.komodo.spi.repository.Repository.UnitOfWork,
java.lang.String)
public void setProperty(Repository.UnitOfWork transaction, String propertyName, Object... values) throws KException
setProperty
in interface KomodoObject
setProperty
in class ObjectImpl
KException
ObjectImpl.setProperty(org.komodo.spi.repository.Repository.UnitOfWork, java.lang.String,
java.lang.Object[])
public void setSchemaElementType(Repository.UnitOfWork uow, SchemaElement.SchemaElementType newSchemaElementType) throws KException
setSchemaElementType
in interface SchemaElement
uow
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newSchemaElementType
- the new value for the schema element type
property (can be null
)KException
- if an error occursSchemaElement.setSchemaElementType(org.komodo.spi.repository.Repository.UnitOfWork,
org.komodo.relational.model.SchemaElement.SchemaElementType)
public StatementOption setStatementOption(Repository.UnitOfWork transaction, String optionName, String optionValue) throws KException
setStatementOption
in interface OptionContainer
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)optionName
- the name of the statement option being added (cannot be empty)optionValue
- the statement option value (can be empty if removing the option)null
if removed)KException
- if an error occursOptionContainer.setStatementOption(org.komodo.spi.repository.Repository.UnitOfWork,
java.lang.String, java.lang.String)
public void setUpdateCount(Repository.UnitOfWork transaction, long newUpdateCount) throws KException
setUpdateCount
in interface AbstractProcedure
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newUpdateCount
- the new value of the update count
optionKException
- if an error occursAbstractProcedure.setUpdateCount(org.komodo.spi.repository.Repository.UnitOfWork, long)
public void setUuid(Repository.UnitOfWork transaction, String newUuid) throws KException
setUuid
in interface AbstractProcedure
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newUuid
- the new value of the UUID
option (can only be empty when removing)KException
- if an error occursAbstractProcedure.setUuid(org.komodo.spi.repository.Repository.UnitOfWork,
java.lang.String)
Copyright © 2013–2019. All rights reserved.