CleansingProcedureDefinition (EBX® Add-ons Version 4.5.9 Java API)

java.lang.Object
- com.orchestranetworks.addon.daqa.cleansing.CleansingProcedureDefinition

public abstract class CleansingProcedureDefinition
extends Object

Defines a cleansing procedure.

Since:: 1.5.0

Constructor Summary

Constructors
Constructor and Description

CleansingProcedureDefinition()

Constructors
Constructor and Description
`CleansingProcedureDefinition()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract boolean`	`canBeUsedForManyFields()` Returns `true` if the current Cleansing procedure can be used for many fields.
`abstract boolean`	`canBeUsedForManyTables()` Returns `true` if the current Cleansing procedure can be used for many tables.
`abstract boolean`	`canBeUsedInProfilingProcedure()` Returns `true` if current Cleansing procedure can be used in profiling mode.
`CleansingOperationDefinition`	`getCleansingOperationDefinitionByClass(String operationClass)` Returns the corresponding `CleansingOperationDefinition` based on its class name.
`abstract List<CleansingOperationDefinition>`	`getCleansingOperations()` Returns a list of `CleansingOperationDefinition` for the current Cleansing procedure.
`abstract CleansingStatisticsProcedure`	`getCleansingProcedureImplementation()` Returns the implementation class for current Cleansing procedure.
`abstract String`	`getCode()` Returns a Cleansing procedure's code.
`abstract DECType`	`getDECType()` Returns a Cleansing procedure's `D.E.C` type.
`abstract com.onwbp.base.text.UserMessage`	`getDescription()` Returns a Cleansing procedure's description.
`List<com.orchestranetworks.schema.SchemaNode>`	`getDisplayFields(com.orchestranetworks.schema.SchemaNode tableNode)` Returns the list of fields to display in Cleansing procedure configuration.
`abstract List<ParameterDefinition>`	`getInputParameters()` Returns a list of input parameters for the current Cleansing procedure.
`abstract com.onwbp.base.text.UserMessage`	`getName()` Returns a Cleansing procedure's name.
`boolean`	`saveOnlyLastValue()` Returns `true` if the current Cleansing procedure saves only last value of Cleansing and Profiling execution.
`com.onwbp.base.text.UserMessage`	`validateCleansingProcedureInputParameters(List<InputParameter> inputParameters)` Validates list of input parameters for a Cleansing procedure.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CleansingProcedureDefinition
```
public CleansingProcedureDefinition()
```
- Method Detail
  - getCode
```
public abstract String getCode()
```
    Returns a Cleansing procedure's code.
    
    Since:
    
    1.5.0
  - getName
```
public abstract com.onwbp.base.text.UserMessage getName()
```
    Returns a Cleansing procedure's name.
    
    Since:
    
    1.5.0
  - getDescription
```
public abstract com.onwbp.base.text.UserMessage getDescription()
```
    Returns a Cleansing procedure's description.
    
    Since:
    
    1.5.0
  - getDECType
```
public abstract DECType getDECType()
```
    Returns a Cleansing procedure's D.E.C type.
    
    Since:
    
    1.5.0
    
    See Also:
    
    DECType
  - canBeUsedInProfilingProcedure
```
public abstract boolean canBeUsedInProfilingProcedure()
```
    Returns true if current Cleansing procedure can be used in profiling mode.
    
    Since:
    
    1.5.0
  - getInputParameters
```
public abstract List<ParameterDefinition> getInputParameters()
```
    Returns a list of input parameters for the current Cleansing procedure.
    
    Since:
    
    1.5.0
    
    See Also:
    
    ParameterDefinition
  - canBeUsedForManyTables
```
public abstract boolean canBeUsedForManyTables()
```
    Returns true if the current Cleansing procedure can be used for many tables.
    
    Since:
    
    1.5.0
  - canBeUsedForManyFields
```
public abstract boolean canBeUsedForManyFields()
```
    Returns true if the current Cleansing procedure can be used for many fields.
    
    Since:
    
    1.5.0
  - saveOnlyLastValue
```
public boolean saveOnlyLastValue()
```
    Returns true if the current Cleansing procedure saves only last value of Cleansing and Profiling execution.
    
    Since:
    
    1.6.0
  - getCleansingOperations
```
public abstract List<CleansingOperationDefinition> getCleansingOperations()
```
    Returns a list of CleansingOperationDefinition for the current Cleansing procedure.
    
    Since:
    
    1.5.0
    
    See Also:
    
    CleansingOperationDefinition
  - getCleansingProcedureImplementation
```
public abstract CleansingStatisticsProcedure getCleansingProcedureImplementation()
```
    Returns the implementation class for current Cleansing procedure.
    
    Since:
    
    1.5.0
    
    See Also:
    
    CleansingStatisticsProcedure
  - getCleansingOperationDefinitionByClass
```
public final CleansingOperationDefinition getCleansingOperationDefinitionByClass(String operationClass)
```
    Returns the corresponding CleansingOperationDefinition based on its class name.
    
    Since:
    
    1.5.0
    
    See Also:
    
    CleansingOperationDefinition
  - getDisplayFields
```
public List<com.orchestranetworks.schema.SchemaNode> getDisplayFields(com.orchestranetworks.schema.SchemaNode tableNode)
```
    Returns the list of fields to display in Cleansing procedure configuration.
    
    Since:
    
    1.6.0
  - validateCleansingProcedureInputParameters
```
public com.onwbp.base.text.UserMessage validateCleansingProcedureInputParameters(List<InputParameter> inputParameters)
```
    Validates list of input parameters for a Cleansing procedure.
    
    Since:
    
    1.6.0

Add-ons Version 4.5.9.

Copyright TIBCO Software Inc. 2001-2022. All rights reserved.
All third party product and company names and third party marks mentioned in this document are the property of their respective owners and are mentioned for identification.

Class CleansingProcedureDefinition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CleansingProcedureDefinition

Method Detail

getCode

getName

getDescription

getDECType

canBeUsedInProfilingProcedure

getInputParameters

canBeUsedForManyTables

canBeUsedForManyFields

saveOnlyLastValue

getCleansingOperations

getCleansingProcedureImplementation

getCleansingOperationDefinitionByClass

getDisplayFields

validateCleansingProcedureInputParameters