com.edustructures.sifworks.tools.mapping
Enum MappingsDirection

java.lang.Object
  java.lang.Enum<MappingsDirection>
      com.edustructures.sifworks.tools.mapping.MappingsDirection

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MappingsDirection>

public enum MappingsDirection
extends java.lang.Enum<MappingsDirection>

Defines the MappingDirection flag, which indicates whether a Mappings operation is being done inbound or outbound

Enum Constant Summary

INBOUND
Direction flag passed to the map method to indicate the agent is mapping values for an inbound message (for example, a SIF_Event that is received from the zone or a SIF_Response).

OUTBOUND
Direction flag passed to the map method to indicate the agent is mapping values for an outbound message (for example, a SIF_Event that is being reported to the zone or a SIF_Response being prepared.) Currently, this flag is used only in conjunction with the ValueSet attribute of the FieldMapping class.

UNSPECIFIED
Direction flag which indicates the agent is not specifying whether the method is being called for an inbound or outbound operation.

Method Summary

static MappingsDirection	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MappingsDirection[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNSPECIFIED

public static final MappingsDirection UNSPECIFIED

Direction flag which indicates the agent is not specifying whether the method is being called for an inbound or outbound operation.

Since:

ADK 1.5

See Also:

Mappings.mapInbound(com.edustructures.sifworks.SIFDataObject, FieldAdaptor), Mappings.mapOutbound(FieldAdaptor,com.edustructures.sifworks.SIFDataObject), MappingsContext.getDirection()

OUTBOUND

public static final MappingsDirection OUTBOUND

Direction flag passed to the map method to indicate the agent is mapping values for an outbound message (for example, a SIF_Event that is being reported to the zone or a SIF_Response being prepared.) Currently, this flag is used only in conjunction with the ValueSet attribute of the FieldMapping class. When a ValueSet is associated with a FieldMapping rule and this flag is passed to the map method, it will automatically lookup the ValueSet by ID and call its translate function on the value produced from the mapping.

Since:

ADK 1.5

See Also:

Mappings.mapInbound(com.edustructures.sifworks.SIFDataObject, FieldAdaptor), Mappings.mapOutbound(FieldAdaptor,com.edustructures.sifworks.SIFDataObject), MappingsContext.getDirection()

INBOUND

public static final MappingsDirection INBOUND

Direction flag passed to the map method to indicate the agent is mapping values for an inbound message (for example, a SIF_Event that is received from the zone or a SIF_Response). Currently, this flag is used only in conjunction with the ValueSet attribute of the FieldMapping class. When a ValueSet is associated with a FieldMapping rule and this flag is passed to the map method, it will automatically lookup the ValueSet by ID and call its translateReverse function on the value produced from the mapping.

Since:

ADK 1.5

See Also:

Mappings.mapInbound(com.edustructures.sifworks.SIFDataObject, FieldAdaptor), Mappings.mapOutbound(FieldAdaptor,com.edustructures.sifworks.SIFDataObject), MappingsContext.getDirection()

Method Detail

values

public static final MappingsDirection[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(MappingsDirection c : MappingsDirection.values())
        System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they're declared

valueOf

public static MappingsDirection valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name