com.univocity.api.engine
Enum EngineScope

java.lang.Object
  extended by java.lang.Enum<EngineScope>
      extended by com.univocity.api.engine.EngineScope
All Implemented Interfaces:
Serializable, Comparable<EngineScope>

public enum EngineScope
extends Enum<EngineScope>

The scopes available in an instance of DataIntegrationEngine.

Author:
uniVocity Software Pty Ltd - dev@univocity.com
See Also:
DataIntegrationEngine, ScopeStorageProvider

Enum Constant Summary
APPLICATION
          The application scope retains and restores values produced while the DataIntegrationEngine is running.
CYCLE
          The cycle scope retains and restores values produced during a data mapping cycle.
MAPPING
          The mapping scope retains and restores values produced during the execution of a single entity mapping.
PERSISTENT
          The persistent scope retains and restores values produced during multiple executions of a DataIntegrationEngine.
STATELESS
          The stateless scope never retains or restores any value.
 
Method Summary
static EngineScope valueOf(String name)
          Returns the enum constant of this type with the specified name.
static EngineScope[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

PERSISTENT

public static final EngineScope PERSISTENT
The persistent scope retains and restores values produced during multiple executions of a DataIntegrationEngine. It must be supported by a ScopeStorageProvider. If a provider is not supplied in the EngineConfiguration, then it will behave as the application scope, and no values will exist once the DataIntegrationEngine is shut down.


APPLICATION

public static final EngineScope APPLICATION
The application scope retains and restores values produced while the DataIntegrationEngine is running. Data stored in the application scope will be available across multiple data mapping cycles. All values are lost once it is shut down.


CYCLE

public static final EngineScope CYCLE
The cycle scope retains and restores values produced during a data mapping cycle. Data stored in the cycle scope will be available across each entity mapping executed within the same cycle. All values are lost once the cycle stops.


MAPPING

public static final EngineScope MAPPING
The mapping scope retains and restores values produced during the execution of a single entity mapping. Data stored in the mapping scope will be available while the entity mapping is being executed. All values are lost once the mapping between two entities has finished.


STATELESS

public static final EngineScope STATELESS
The stateless scope never retains or restores any value. FunctionCalls will never have their results cached in the scope, therefore every call to an stateless-scoped function will trigger a new execution.

Method Detail

values

public static EngineScope[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (EngineScope c : EngineScope.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static EngineScope valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null


Copyright © 2015 uniVocity Software Pty Ltd. All rights reserved.