org.neociclo.odetteftp.protocol
Class CommandFormat.Field

java.lang.Object
  extended by org.neociclo.odetteftp.protocol.CommandFormat.Field
Enclosing interface:
CommandFormat

public static class CommandFormat.Field
extends Object

Command Format is compound of one or more fields. This class represents the Field attributes definition.

Dynamic fields are used on protocol version 2.0 implementation and above to indicate the field size or position is computed according to another defined CommandFormat field. Eg.: The SFNAREAST field size is calculate using SFNAREASL numeric value.

Long filename extension is used in protocol version 1.3 and 1.3 implementations to support datasetName longer than 26 octets, but its a proprietary definition in SFID command format (up to 128 octets length).


Field Summary
static char ALPHANUMERIC_TYPE
          An alphanumeric field of length n octets.
static char BINARY_TYPE
          A binary field of length n octets.
static char ENCODED_TYPE
          An field of length n octets, encoded using [UTF-8].
static char FIXED_FORMAT
          A field containing fixed values.
static char NUMERIC_TYPE
          A numeric field of length n octets.
static char VARIABLE_FORMAT
          A field with variable values within a defined range.
 
Constructor Summary
CommandFormat.Field(int pos, String name, char format, char type, int size)
           
CommandFormat.Field(int pos, String name, char format, char type, String lengthFieldName)
           
CommandFormat.Field(String posAfterFieldName, String name, char format, char type, int size)
           
CommandFormat.Field(String posAfterFieldName, String name, char format, char type, String lengthFieldName)
           
 
Method Summary
 char getFormat()
           
 String getLengthFieldName()
           
 String getName()
           
 int getPosition()
           
 String getPositionAfterFieldName()
           
 int getSize()
           
 char getType()
           
 boolean isDynamic()
           
 boolean shouldComputePosition()
           
 boolean shouldComputeSize()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ALPHANUMERIC_TYPE

public static final char ALPHANUMERIC_TYPE
An alphanumeric field of length n octets.

See Also:
Constant Field Values

BINARY_TYPE

public static final char BINARY_TYPE
A binary field of length n octets.

Numbers encoded as binary are always unsigned and in network byte order.

See Also:
Constant Field Values

ENCODED_TYPE

public static final char ENCODED_TYPE
An field of length n octets, encoded using [UTF-8].

See Also:
Constant Field Values

FIXED_FORMAT

public static final char FIXED_FORMAT
A field containing fixed values. All allowable values for the field are enumerated in the command definition.

See Also:
Constant Field Values

NUMERIC_TYPE

public static final char NUMERIC_TYPE
A numeric field of length n octets. This type of attribute contains characters from the following set:
    The numerals:               0 to 9
    The upper case letters:     A to Z
    The following special set:  / - . & ( ) space.
 
Space is not allowed as an embedded character.

See Also:
Constant Field Values

VARIABLE_FORMAT

public static final char VARIABLE_FORMAT
A field with variable values within a defined range. For example the SFIDFSIZ field may contain any integer value between 0000000 and 9999999.

See Also:
Constant Field Values
Constructor Detail

CommandFormat.Field

public CommandFormat.Field(int pos,
                           String name,
                           char format,
                           char type,
                           int size)

CommandFormat.Field

public CommandFormat.Field(int pos,
                           String name,
                           char format,
                           char type,
                           String lengthFieldName)

CommandFormat.Field

public CommandFormat.Field(String posAfterFieldName,
                           String name,
                           char format,
                           char type,
                           int size)

CommandFormat.Field

public CommandFormat.Field(String posAfterFieldName,
                           String name,
                           char format,
                           char type,
                           String lengthFieldName)
Method Detail

getFormat

public char getFormat()

getName

public String getName()

getPosition

public int getPosition()

getSize

public int getSize()

getType

public char getType()

isDynamic

public boolean isDynamic()

shouldComputeSize

public boolean shouldComputeSize()

shouldComputePosition

public boolean shouldComputePosition()

getLengthFieldName

public String getLengthFieldName()

getPositionAfterFieldName

public String getPositionAfterFieldName()


ACCORD