Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.rocketsoftware.mvapi
Class MVConstants

java.lang.Object
  extended by com.rocketsoftware.mvapi.MVConstants

public class MVConstants
extends java.lang.Object

Defines constants used by the MVAPI

Nested Class Summary
static class MVConstants.LicenseType
          Enumeration of the allowable license types.
 
Field Summary
static java.lang.String ACCOUNT
           
static java.lang.String ACCOUNT_PASSWORD
           
static java.lang.String AM
          Attribute mark delimiter
static java.util.Properties API_PROPERTIES
          Client properties.
static java.lang.String API_VERSION_KEY
           
static char ATTR_MARK
          The multidimensional database Attribute Mark code.
static java.lang.String CONNECTION_OPTIONS
           
static byte CR
          Carriage return control character.
static java.lang.String D3_SERVER_CONNECT_RESPONSE
           
static int DEFAULT_COORD
          The default coordinate while coordinate a value from the multidimensional file.
static java.lang.String DEFAULT_MVAPI_APP_NAME
          Default client id.
static java.lang.String DLE
          Data link escape character
static java.lang.String EMPTY_STR
          Constants for an empty string.
static java.util.List<java.lang.String> EMPTY_STR_LST
          Constants for an empty string list, on which it only contains one empty string entry.
static char EOR_MARK
          The multidimensional database End of Record Mark code.
static byte[] ESC_CR_SEQ
           
static byte[] ESC_DLE_SEQ
           
static byte[] ESC_LF_SEQ
          Strings used for escaping special characters embedded in data stream.
static byte LF
          Line feed control character.
static java.lang.String MSG_ACCOUNT_MAINT_DISABLED
           
static java.lang.String MSG_ACCOUNT_MAINT_ENABLED
           
static java.lang.String MSG_ACCOUNT_MAINT_ERROR
           
static java.lang.String MSG_ACCOUNT_MAINT_INVALID_ACCOUNT
          message constants
static java.lang.String MSG_ACCOUNT_MAINT_OPEN
           
static java.lang.String MVAPI
          MVAPI protocol prefix constant
static int MVAPI_CLOSE_READ_RESPONSE_TIMEOUT
          MVAPI Socket read timeout.
static java.lang.String MVAPI_CONNECTION_TIMEOUT_DEFAULT_MILLISECONDS
          MVAPI Socket connection default.
static java.lang.String MVAPI_CONNECTION_TIMEOUT_PROPERTY
          MVAPI Socket connection timeout property.
static java.lang.String MVAPI_PING_COMMAND
          MVAPI Socket ping command.
static int MVAPI_PING_TIMEOUT_DEFAULT_MILLISECONDS
          MVAPI Socket ping timeout.
static java.lang.String MVAPI_QUERY
          MVAPI Query command - gets the results in one bundle.
static java.lang.String MVAPI_QUERY_STREAM
          MVAPI Query command - gets stream of results formatted as itemlen item body.
static java.lang.String MVAPI_STREAM_START
          MVAPI Stream start message
static java.lang.String MVBASE_SERVER_CONNECT_RESPONSE
           
static java.lang.String MVSP_ACCOUNT
          MVSP account.
static java.lang.String MVSP_ACCOUNT_MAINT
          MVSP subroutine that enables/disables an account for MVSP use.
static java.lang.String MVSP_ACCOUNT_MAINT_LIST
          MVSP subroutine to list enabled accounts.
static java.lang.String MVSP_BOD
          MVSP begin user data
static java.lang.String MVSP_BOD_ESCAPED
          MVSP begin user data - used when data contains embedded [MVSP001] tags.
static java.lang.String MVSP_CALL
          MVSP CALL command.
static java.lang.String MVSP_CALLC
          MVSP CALLC command.
static java.lang.String MVSP_CLEARSELECT
          MVSP CLEARSELECT command
static java.lang.String MVSP_CLIENT_APPNAME
          Client id property constant.
static java.lang.String MVSP_CLOSEROOT
          MVSP CLOSEROOT command
static java.lang.String MVSP_CONNECT
           
static java.lang.String MVSP_EOD
          MVSP end user data
static java.lang.String MVSP_ERR
          MVSP begin error context
static java.lang.String MVSP_EXECUTE
          MVSP EXECUTE command.
static java.lang.String MVSP_EXIT
          MVSP Exit command.
static java.lang.String MVSP_KEY
          MVSP KEY command
static java.lang.String MVSP_LOGON_USER
          MVSP LOGON command.
static java.lang.String MVSP_LOGTO_ACCOUNT
          MVSP LOGTO command.
static java.lang.String MVSP_MAIN
          MVSP main program.
static java.lang.String MVSP_QUERY
          MVSP QUERY command.
static java.lang.String MVSP_ROOT
          MVSP ROOT command
static java.lang.String MVSP_USER
          MVSP user
static java.lang.String MVSP_VERSION
           
static java.lang.String PASSWORD
           
static java.lang.String SB
          Buffer mark delimiter
static java.lang.String SM
          Segment mark delimiter
static char SUBVAL_MARK
          The multidimensional database SubValue Mark code.
static java.lang.String SVM
          SubValue mark delimiter
static java.lang.String TRX_BEGIN
           
static java.lang.String TRX_COMMIT
           
static java.lang.String TRX_ROLLBACK
           
static java.lang.String TRX_STATUS
           
static java.lang.String UNIVERSE
           
static java.lang.String USE_ENT_LIC
           
static java.lang.String USE_LICENSE_TYPE
           
static java.lang.String USE_MCP_CONVERSION
           
static java.lang.String USE_SSL_CONNECT
           
static java.lang.String USERNAME
           
static java.lang.String UV_SERVER_CONNECT_ACCOUNT
           
static java.lang.String UV_SERVER_CONNECT_ENTER_PASSWORD
           
static java.lang.String UV_SERVER_CONNECT_ENTER_USER
           
static java.lang.String UV_SERVER_CONNECT_INVALID_USER
           
static java.lang.String UV_SERVER_CONNECT_LOGGEDON_RESPONSE
           
static java.lang.String UV_SERVER_CONNECT_RESPONSE
           
static char VAL_MARK
          The multidimensional database Value Mark code.
static java.lang.String VM
          Value mark delimiter
 
Constructor Summary
MVConstants()
           
 
Method Summary
static int compareSystemDelimiter(char c1, char c2)
          Compare c1 and c2 with the system delimiter order
static int compareSystemDelimiter(java.lang.String s1, java.lang.String s2)
           
static boolean isSystemDelimiter(java.lang.String s)
          Checks for a system delimiter.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SM

public static java.lang.String SM
Segment mark delimiter

AM

public static java.lang.String AM
Attribute mark delimiter

VM

public static java.lang.String VM
Value mark delimiter

SVM

public static java.lang.String SVM
SubValue mark delimiter

SB

public static java.lang.String SB
Buffer mark delimiter

DLE

public static java.lang.String DLE
Data link escape character

MVSP_VERSION

public static final java.lang.String MVSP_VERSION
See Also:
Constant Field Values

MVSP_USER

public static final java.lang.String MVSP_USER
MVSP user

See Also:
Constant Field Values

MVSP_ACCOUNT

public static final java.lang.String MVSP_ACCOUNT
MVSP account.

See Also:
Constant Field Values

MVSP_MAIN

public static final java.lang.String MVSP_MAIN
MVSP main program.

See Also:
Constant Field Values

MVAPI

public static final java.lang.String MVAPI
MVAPI protocol prefix constant

See Also:
Constant Field Values

MVAPI_STREAM_START

public static final java.lang.String MVAPI_STREAM_START
MVAPI Stream start message

See Also:
Constant Field Values

MVAPI_QUERY_STREAM

public static final java.lang.String MVAPI_QUERY_STREAM
MVAPI Query command - gets stream of results formatted as itemlen item body.

See Also:
Constant Field Values

MVAPI_QUERY

public static final java.lang.String MVAPI_QUERY
MVAPI Query command - gets the results in one bundle.

See Also:
Constant Field Values

MVSP_ACCOUNT_MAINT

public static final java.lang.String MVSP_ACCOUNT_MAINT
MVSP subroutine that enables/disables an account for MVSP use.

See Also:
Constant Field Values

MVSP_ACCOUNT_MAINT_LIST

public static final java.lang.String MVSP_ACCOUNT_MAINT_LIST
MVSP subroutine to list enabled accounts.

See Also:
Constant Field Values

MVSP_CLIENT_APPNAME

public static final java.lang.String MVSP_CLIENT_APPNAME
Client id property constant.

See Also:
Constant Field Values

DEFAULT_MVAPI_APP_NAME

public static final java.lang.String DEFAULT_MVAPI_APP_NAME
Default client id.

See Also:
Constant Field Values

MVSP_BOD

public static final java.lang.String MVSP_BOD
MVSP begin user data

See Also:
Constant Field Values

MVSP_BOD_ESCAPED

public static final java.lang.String MVSP_BOD_ESCAPED
MVSP begin user data - used when data contains embedded [MVSP001] tags.

See Also:
Constant Field Values

MVSP_EOD

public static final java.lang.String MVSP_EOD
MVSP end user data

See Also:
Constant Field Values

MVSP_ERR

public static final java.lang.String MVSP_ERR
MVSP begin error context

See Also:
Constant Field Values

MVSP_EXIT

public static final java.lang.String MVSP_EXIT
MVSP Exit command.

See Also:
Constant Field Values

MVSP_LOGON_USER

public static final java.lang.String MVSP_LOGON_USER
MVSP LOGON command.

See Also:
Constant Field Values

MVSP_LOGTO_ACCOUNT

public static final java.lang.String MVSP_LOGTO_ACCOUNT
MVSP LOGTO command.

See Also:
Constant Field Values

MVSP_EXECUTE

public static final java.lang.String MVSP_EXECUTE
MVSP EXECUTE command.

See Also:
Constant Field Values

MVSP_QUERY

public static final java.lang.String MVSP_QUERY
MVSP QUERY command.

See Also:
Constant Field Values

MVSP_CALL

public static final java.lang.String MVSP_CALL
MVSP CALL command.

See Also:
Constant Field Values

MVSP_CALLC

public static final java.lang.String MVSP_CALLC
MVSP CALLC command.

See Also:
Constant Field Values

MVSP_CLEARSELECT

public static final java.lang.String MVSP_CLEARSELECT
MVSP CLEARSELECT command

See Also:
Constant Field Values

MVSP_ROOT

public static final java.lang.String MVSP_ROOT
MVSP ROOT command

See Also:
Constant Field Values

MVSP_KEY

public static final java.lang.String MVSP_KEY
MVSP KEY command

See Also:
Constant Field Values

MVSP_CLOSEROOT

public static final java.lang.String MVSP_CLOSEROOT
MVSP CLOSEROOT command

See Also:
Constant Field Values

MVSP_CONNECT

public static final java.lang.String MVSP_CONNECT
See Also:
Constant Field Values

MVAPI_CONNECTION_TIMEOUT_PROPERTY

public static final java.lang.String MVAPI_CONNECTION_TIMEOUT_PROPERTY
MVAPI Socket connection timeout property.

See Also:
Constant Field Values

MVAPI_CONNECTION_TIMEOUT_DEFAULT_MILLISECONDS

public static final java.lang.String MVAPI_CONNECTION_TIMEOUT_DEFAULT_MILLISECONDS
MVAPI Socket connection default.

See Also:
Constant Field Values

MVAPI_PING_TIMEOUT_DEFAULT_MILLISECONDS

public static final int MVAPI_PING_TIMEOUT_DEFAULT_MILLISECONDS
MVAPI Socket ping timeout.

See Also:
Constant Field Values

MVAPI_CLOSE_READ_RESPONSE_TIMEOUT

public static final int MVAPI_CLOSE_READ_RESPONSE_TIMEOUT
MVAPI Socket read timeout.

See Also:
Constant Field Values

MVAPI_PING_COMMAND

public static final java.lang.String MVAPI_PING_COMMAND
MVAPI Socket ping command.

See Also:
Constant Field Values

ATTR_MARK

public static final char ATTR_MARK
The multidimensional database Attribute Mark code.

See Also:
Constant Field Values

VAL_MARK

public static final char VAL_MARK
The multidimensional database Value Mark code.

See Also:
Constant Field Values

SUBVAL_MARK

public static final char SUBVAL_MARK
The multidimensional database SubValue Mark code.

See Also:
Constant Field Values

EOR_MARK

public static final char EOR_MARK
The multidimensional database End of Record Mark code.

See Also:
Constant Field Values

LF

public static final byte LF
Line feed control character.

See Also:
Constant Field Values

CR

public static final byte CR
Carriage return control character.

See Also:
Constant Field Values

ESC_LF_SEQ

public static final byte[] ESC_LF_SEQ
Strings used for escaping special characters embedded in data stream.

ESC_CR_SEQ

public static final byte[] ESC_CR_SEQ

ESC_DLE_SEQ

public static final byte[] ESC_DLE_SEQ

DEFAULT_COORD

public static final int DEFAULT_COORD
The default coordinate while coordinate a value from the multidimensional file. This default coordinate could either mean beginning or at the end of a value it refers in the current context.

See Also:
Constant Field Values

EMPTY_STR

public static final java.lang.String EMPTY_STR
Constants for an empty string.

See Also:
Constant Field Values

MSG_ACCOUNT_MAINT_INVALID_ACCOUNT

public static final java.lang.String MSG_ACCOUNT_MAINT_INVALID_ACCOUNT
message constants

See Also:
Constant Field Values

MSG_ACCOUNT_MAINT_ENABLED

public static final java.lang.String MSG_ACCOUNT_MAINT_ENABLED
See Also:
Constant Field Values

MSG_ACCOUNT_MAINT_DISABLED

public static final java.lang.String MSG_ACCOUNT_MAINT_DISABLED
See Also:
Constant Field Values

MSG_ACCOUNT_MAINT_OPEN

public static final java.lang.String MSG_ACCOUNT_MAINT_OPEN
See Also:
Constant Field Values

MSG_ACCOUNT_MAINT_ERROR

public static final java.lang.String MSG_ACCOUNT_MAINT_ERROR
See Also:
Constant Field Values

D3_SERVER_CONNECT_RESPONSE

public static final java.lang.String D3_SERVER_CONNECT_RESPONSE
See Also:
Constant Field Values

MVBASE_SERVER_CONNECT_RESPONSE

public static final java.lang.String MVBASE_SERVER_CONNECT_RESPONSE
See Also:
Constant Field Values

UV_SERVER_CONNECT_RESPONSE

public static final java.lang.String UV_SERVER_CONNECT_RESPONSE
See Also:
Constant Field Values

UV_SERVER_CONNECT_LOGGEDON_RESPONSE

public static final java.lang.String UV_SERVER_CONNECT_LOGGEDON_RESPONSE
See Also:
Constant Field Values

UV_SERVER_CONNECT_ENTER_USER

public static final java.lang.String UV_SERVER_CONNECT_ENTER_USER
See Also:
Constant Field Values

UV_SERVER_CONNECT_ENTER_PASSWORD

public static final java.lang.String UV_SERVER_CONNECT_ENTER_PASSWORD
See Also:
Constant Field Values

UV_SERVER_CONNECT_ACCOUNT

public static final java.lang.String UV_SERVER_CONNECT_ACCOUNT
See Also:
Constant Field Values

UV_SERVER_CONNECT_INVALID_USER

public static final java.lang.String UV_SERVER_CONNECT_INVALID_USER
See Also:
Constant Field Values

UNIVERSE

public static final java.lang.String UNIVERSE
See Also:
Constant Field Values

API_VERSION_KEY

public static final java.lang.String API_VERSION_KEY
See Also:
Constant Field Values

TRX_BEGIN

public static final java.lang.String TRX_BEGIN
See Also:
Constant Field Values

TRX_COMMIT

public static final java.lang.String TRX_COMMIT
See Also:
Constant Field Values

TRX_ROLLBACK

public static final java.lang.String TRX_ROLLBACK
See Also:
Constant Field Values

TRX_STATUS

public static final java.lang.String TRX_STATUS
See Also:
Constant Field Values

USERNAME

public static final java.lang.String USERNAME
See Also:
Constant Field Values

PASSWORD

public static final java.lang.String PASSWORD
See Also:
Constant Field Values

ACCOUNT

public static final java.lang.String ACCOUNT
See Also:
Constant Field Values

ACCOUNT_PASSWORD

public static final java.lang.String ACCOUNT_PASSWORD
See Also:
Constant Field Values

USE_SSL_CONNECT

public static final java.lang.String USE_SSL_CONNECT
See Also:
Constant Field Values

USE_MCP_CONVERSION

public static final java.lang.String USE_MCP_CONVERSION
See Also:
Constant Field Values

USE_ENT_LIC

public static final java.lang.String USE_ENT_LIC
See Also:
Constant Field Values

USE_LICENSE_TYPE

public static final java.lang.String USE_LICENSE_TYPE
See Also:
Constant Field Values

CONNECTION_OPTIONS

public static final java.lang.String CONNECTION_OPTIONS
See Also:
Constant Field Values

EMPTY_STR_LST

public static final java.util.List<java.lang.String> EMPTY_STR_LST
Constants for an empty string list, on which it only contains one empty string entry.

API_PROPERTIES

public static final java.util.Properties API_PROPERTIES
Client properties.

Since:
1.0
Constructor Detail

MVConstants

public MVConstants()
Method Detail

isSystemDelimiter

public static boolean isSystemDelimiter(java.lang.String s)
Checks for a system delimiter.

Parameters:
s - String to check
Returns:
true if string is a system delimiter

compareSystemDelimiter

public static int compareSystemDelimiter(char c1,
                                         char c2)
Compare c1 and c2 with the system delimiter order

Parameters:
c1 - char 1
c2 - char 2
Returns:
0 if equal, -1 if s1s2

compareSystemDelimiter

public static int compareSystemDelimiter(java.lang.String s1,
                                         java.lang.String s2)
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD