Skip navigation links

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

com.essbase.eas.essbase.server
Class RulesObjectPrimitives

java.lang.Object
  extended by com.essbase.eas.essbase.server.RulesObjectPrimitives

public class RulesObjectPrimitives
extends java.lang.Object

This class provides the primitive operations for a rules object. In the current implementation, no instances of this class should ever be instantiated.

Since:
6.2.0
Version:
6.5.4
Author:
Madhavi Bolisetty

Constructor Summary
RulesObjectPrimitives()
           

 

Method Summary
static int applyDelimiter(EssSession session, short delimiterType, char delimiter, int fixedColWidth, java.util.ArrayList dataRecordList)
           
static int applyFieldAttributes(EssSession session, java.util.LinkedList fieldAttributeInfoList, java.util.ArrayList dataRecordList)
           
static int applyRules(EssSession session, java.util.ArrayList rulesList, java.util.ArrayList dataRecordList)
           
static boolean copy(EssSession destSession, java.lang.String destApp, java.lang.String destDatabase, java.lang.String destRulesObject, java.lang.String srcApp, java.lang.String srcDatabase, java.lang.String srcRulesObject)
          copies a rules object within an individual server.
static int freeLocalContext(long localContextHandle)
           
static int freeRulesFileContext(long context)
           
static boolean get(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String objName, java.lang.String localName, boolean lock)
          gets a rules object
static java.util.List getDSNList(EssSession session)
           
static int getEncodingInfo(long context, EncodingInfo encodingInfo)
           
static java.util.List getList(EssSession session, java.lang.String application, java.lang.String database)
           
static int lock(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String rulesObjectName)
          locks a rules object
static int parseDBHeader(EssSession session, java.util.LinkedList fieldAttributeInfoList, java.util.ArrayList fieldList)
           
static boolean put(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String objName, java.lang.String localName, boolean lock)
          puts a rules object
static int readDataFile(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String dataFileName, short viewCount, int startRecord, int fileType, java.util.ArrayList recordList)
           
static java.lang.String readDBHeaderRecord(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String dataFileName, int dataFileExtension, short viewCount, int startRecord)
           
static java.lang.String readDLHeaderRecord(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String dataFileName, int dataFileExtension, short viewCount, int startRecord)
           
static java.lang.String readHeaderRecord(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String dataFileName, int dataFileExtension, short viewCount, int startRecord)
           
static boolean readRulesObject(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String rulesObjectName, boolean lock, RulesObject rulesObject, java.util.Collection errors)
           
static int readSQLRecords(EssSession session, DPSqlConnectionInfo sqlConnectionInfo, int startRecord, short viewCount, java.util.ArrayList columnNameList, java.util.ArrayList recordList)
           
static boolean rename(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String newRulesObjectName, java.lang.String oldRulesObjectName)
          renames a rules object.
static boolean saveRulesObject(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String rulesObjectName, RulesObject rulesObject, java.util.Collection errors)
           
static boolean unlock(EssSession session, java.lang.String appName, java.lang.String dbName, java.lang.String rulesObjectName)
          unlocks a rules object.
static int verify(EssSession session, java.lang.String appName, java.lang.String dbName, DPAssociatedObject associatedObject, java.util.ArrayList errorList)
           

 

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

 

Constructor Detail

RulesObjectPrimitives

public RulesObjectPrimitives()

Method Detail

getList

public static java.util.List getList(EssSession session,
                                     java.lang.String application,
                                     java.lang.String database)

get

public static boolean get(EssSession session,
                          java.lang.String appName,
                          java.lang.String dbName,
                          java.lang.String objName,
                          java.lang.String localName,
                          boolean lock)
gets a rules object
Parameters:
session - - session object for this command.
appName - - name of application.
dbName - - name of database.
objName - - name of the object.
localName - - name of the file to create
Returns:
true if the delete succeeds. What do we do about messages if the call fails?

put

public static boolean put(EssSession session,
                          java.lang.String appName,
                          java.lang.String dbName,
                          java.lang.String objName,
                          java.lang.String localName,
                          boolean lock)
puts a rules object
Parameters:
session - - session object for this command.
appName - - name of application.
dbName - - name of database.
objName - - name of the object.
Returns:
true if the delete succeeds. What do we do about messages if the call fails?

lock

public static int lock(EssSession session,
                       java.lang.String appName,
                       java.lang.String dbName,
                       java.lang.String rulesObjectName)
locks a rules object
Parameters:
session - - session object for this command.
appName - - name of application containing the rules object.
dbName - - name of database containing the rules object.
rulesObjectName - - name of the rules object.
Returns:
true if the lock succeeds.

unlock

public static boolean unlock(EssSession session,
                             java.lang.String appName,
                             java.lang.String dbName,
                             java.lang.String rulesObjectName)
unlocks a rules object.
Parameters:
session - - session object for this command.
appName - - name of application containing the rules object.
dbName - - name of database containing the rules object.
rulesObjectName - - name of the rules object
Returns:
true if the lock succeeds.

copy

public static boolean copy(EssSession destSession,
                           java.lang.String destApp,
                           java.lang.String destDatabase,
                           java.lang.String destRulesObject,
                           java.lang.String srcApp,
                           java.lang.String srcDatabase,
                           java.lang.String srcRulesObject)
copies a rules object within an individual server.

Should we throw an exception here?

Parameters:
session - - session object server.
destApp - - application name for the copy.
destDatabase - - database name for the copy.
destRulesObject - - RulesObject name for the copy.
srcApp - - application to be copied.
srcDatabase - - database to be copied.
srcRulesObject - - RulesObject name to be copied.
Returns:
true if the database is successfully copied. What do we do about messages if the call fails?

rename

public static boolean rename(EssSession session,
                             java.lang.String appName,
                             java.lang.String dbName,
                             java.lang.String newRulesObjectName,
                             java.lang.String oldRulesObjectName)
renames a rules object.
Parameters:
session - - session object for this command.
appName - - name of application containing the rules object.
dbName - - name of database containing the rules object.
newRulesObjectName - - name of the new rules object.
oldRulesObjectName - - name of the old rules object.
Returns:
true if the rename succeeds.

readRulesObject

public static boolean readRulesObject(EssSession session,
                                      java.lang.String appName,
                                      java.lang.String dbName,
                                      java.lang.String rulesObjectName,
                                      boolean lock,
                                      RulesObject rulesObject,
                                      java.util.Collection errors)

readDataFile

public static int readDataFile(EssSession session,
                               java.lang.String appName,
                               java.lang.String dbName,
                               java.lang.String dataFileName,
                               short viewCount,
                               int startRecord,
                               int fileType,
                               java.util.ArrayList recordList)

readHeaderRecord

public static java.lang.String readHeaderRecord(EssSession session,
                                                java.lang.String appName,
                                                java.lang.String dbName,
                                                java.lang.String dataFileName,
                                                int dataFileExtension,
                                                short viewCount,
                                                int startRecord)

readDBHeaderRecord

public static java.lang.String readDBHeaderRecord(EssSession session,
                                                  java.lang.String appName,
                                                  java.lang.String dbName,
                                                  java.lang.String dataFileName,
                                                  int dataFileExtension,
                                                  short viewCount,
                                                  int startRecord)

readDLHeaderRecord

public static java.lang.String readDLHeaderRecord(EssSession session,
                                                  java.lang.String appName,
                                                  java.lang.String dbName,
                                                  java.lang.String dataFileName,
                                                  int dataFileExtension,
                                                  short viewCount,
                                                  int startRecord)

applyRules

public static int applyRules(EssSession session,
                             java.util.ArrayList rulesList,
                             java.util.ArrayList dataRecordList)

applyDelimiter

public static int applyDelimiter(EssSession session,
                                 short delimiterType,
                                 char delimiter,
                                 int fixedColWidth,
                                 java.util.ArrayList dataRecordList)

applyFieldAttributes

public static int applyFieldAttributes(EssSession session,
                                       java.util.LinkedList fieldAttributeInfoList,
                                       java.util.ArrayList dataRecordList)

parseDBHeader

public static int parseDBHeader(EssSession session,
                                java.util.LinkedList fieldAttributeInfoList,
                                java.util.ArrayList fieldList)

verify

public static int verify(EssSession session,
                         java.lang.String appName,
                         java.lang.String dbName,
                         DPAssociatedObject associatedObject,
                         java.util.ArrayList errorList)

saveRulesObject

public static boolean saveRulesObject(EssSession session,
                                      java.lang.String appName,
                                      java.lang.String dbName,
                                      java.lang.String rulesObjectName,
                                      RulesObject rulesObject,
                                      java.util.Collection errors)

getDSNList

public static java.util.List getDSNList(EssSession session)

readSQLRecords

public static int readSQLRecords(EssSession session,
                                 DPSqlConnectionInfo sqlConnectionInfo,
                                 int startRecord,
                                 short viewCount,
                                 java.util.ArrayList columnNameList,
                                 java.util.ArrayList recordList)

freeRulesFileContext

public static int freeRulesFileContext(long context)

getEncodingInfo

public static int getEncodingInfo(long context,
                                  EncodingInfo encodingInfo)

freeLocalContext

public static int freeLocalContext(long localContextHandle)

Skip navigation links

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

Copyright © 2001, 2012, Oracle. All rights reserved.