Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.flexstor.flexdbserver.disguise
Class BucketHelper  view BucketHelper download BucketHelper.java

java.lang.Object
  extended bycom.flexstor.flexdbserver.disguise.DisguiseHelper
      extended bycom.flexstor.flexdbserver.disguise.BucketHelper

public class BucketHelper
extends DisguiseHelper

BucketFieldsFinder retrieves field information for buckets in a disguise


Field Summary
private  com.flexstor.ejb.bucket.persist.ServerBucketExtendData bucketExtend
           
static int BY_ID
           
static int BY_INDEX
           
static int BY_LABEL
           
static int BY_NAME
           
 
Fields inherited from class com.flexstor.flexdbserver.disguise.DisguiseHelper
disguiseExtend
 
Constructor Summary
BucketHelper(int nDisguiseId)
          Loads the global disguise if it wasn't loaded previously
BucketHelper(java.lang.String sDisguiseName)
          Loads the global disguise if it wasn't loaded previously
 
Method Summary
 int[] getAssetSkeletonFieldIds()
          Retrieve a list of field ids used as the skeleton fields for an asset
 int getBucketId(int nBucketIndex)
          Retrieve the id of a bucket based on its index
 int getBucketId(java.lang.String sBucketDesc, int nMode)
          Retrieve the id of a bucket based on either the bucket name or label
 int getBucketLevel(int nBucketDesc, int nMode)
          Retrieve the bucket level based on the bucket id or index
 int getBucketLevel(java.lang.String sBucketDesc, int nMode)
          Retrieve the bucket level based on either the bucket name or label
 int getBucketType(int nBucketDesc, int nMode)
          Retrieve the bucket type based on the bucket id or index
 int getBucketType(java.lang.String sBucketDesc, int nMode)
          Retrieve the bucket type based on either the bucket name or label
 java.lang.String getFieldData(int nBucketDesc, int nBucketMode, java.lang.String sFieldDesc, int nFieldMode, com.flexstor.common.data.ejb.search.SkeletonData skelData, com.flexstor.common.data.ejb.search.SkeletonFieldData skelField)
          Get the field value stored in a SkeletonData object
private  java.lang.String getFieldData(java.lang.String sFieldDesc, int nFieldMode, com.flexstor.common.data.ejb.search.SkeletonData skelData, com.flexstor.common.data.ejb.search.SkeletonFieldData skelField)
          This method assumes that bucketExtend is already loaded with a valid ServerBucketExtendData object.
 java.lang.String getFieldData(java.lang.String sBucketDesc, int nBucketMode, java.lang.String sFieldDesc, int nFieldMode, com.flexstor.common.data.ejb.search.SkeletonData skelData, com.flexstor.common.data.ejb.search.SkeletonFieldData skelField)
          Get the field value stored in a SkeletonData object
private  com.flexstor.ejb.field.persist.ServerFieldExtendData getFieldExtendDataObject(int nFieldDesc, int nFieldMode)
          Retrieve the ServerFieldExtendData based on either the field id or index
 com.flexstor.ejb.field.persist.ServerFieldExtendData getFieldExtendDataObject(int nBucketDesc, int nBucketMode, int nFieldDesc, int nFieldMode)
          Retrieve the ServerFieldExtendData based on either the field id or index
 com.flexstor.ejb.field.persist.ServerFieldExtendData getFieldExtendDataObject(int nBucketDesc, int nBucketMode, java.lang.String sFieldDesc, int nFieldMode)
          Retrieve the ServerFieldExtendData based on either the field name or label
private  com.flexstor.ejb.field.persist.ServerFieldExtendData getFieldExtendDataObject(java.lang.String sFieldDesc, int nFieldMode)
          Retrieve the ServerFieldExtendData based on either the field name or label
 com.flexstor.ejb.field.persist.ServerFieldExtendData getFieldExtendDataObject(java.lang.String sBucketDesc, int nBucketMode, int nFieldDesc, int nFieldMode)
          Retrieve the ServerFieldExtendData based on either the field id or index
 com.flexstor.ejb.field.persist.ServerFieldExtendData getFieldExtendDataObject(java.lang.String sBucketDesc, int nBucketMode, java.lang.String sFieldDesc, int nFieldMode)
          Retrieve the ServerFieldExtendData based on either the field name or label
 int getFieldId(int nBucketDesc, int nBucketMode, java.lang.String sFieldDesc, int nFieldMode)
          Retrieve the field id of a bucket based on either the field name or label
private  int getFieldId(java.lang.String sFieldDesc, int nFieldMode)
          This method assumes that bucketExtend is already loaded with a valid ServerBucketExtendData object.
 int getFieldId(java.lang.String sBucketDesc, int nBucketMode, java.lang.String sFieldDesc, int nFieldMode)
          Retrieve the field id of a bucket based on either the field name or label
private  int[] getFieldIds()
          This method assumes that bucketExtend is already loaded with a valid ServerBucketExtendData object.
 int[] getFieldIds(int nBucketDesc, int nBucketMode)
          Retrieve an array of all field ids of a bucket based on either the field name or label
 int[] getFieldIds(java.lang.String sBucketDesc, int nBucketMode)
          Retrieve an array of all field ids of a bucket based on either the field name or label
 int getFieldIndex(int nBucketDesc, int nBucketMode, java.lang.String sFieldDesc, int nFieldMode)
          Retrieve the field index of a bucket based on either the field name or label
private  int getFieldIndex(java.lang.String sFieldDesc, int nFieldMode)
          This method assumes that bucketExtend is already loaded with a valid ServerBucketExtendData object.
 int getFieldIndex(java.lang.String sBucketDesc, int nBucketMode, java.lang.String sFieldDesc, int nFieldMode)
          Retrieve the field index of a bucket based on either the field name or label
private  java.lang.String getFieldLabel(int nFieldDesc, int nFieldMode)
          This method assumes that bucketExtend is already loaded with a valid ServerBucketExtendData object.
 java.lang.String getFieldLabel(int nBucketDesc, int nBucketMode, int nFieldDesc, int nFieldMode)
          Retrieve the field label of a bucket based on either the field id or index
 java.lang.String getFieldLabel(java.lang.String sBucketDesc, int nBucketMode, int nFieldDesc, int nFieldMode)
          Retrieve the field label of a bucket based on either the field id or index
private  boolean loadBucket(int nBucketDesc, int nMode)
          Load a bucket to be used during subsequent method calls
private  boolean loadBucket(java.lang.String sBucketDesc, int nMode)
          Load a bucket to be used during subsequent method calls
 
Methods inherited from class com.flexstor.flexdbserver.disguise.DisguiseHelper
getBucketExtendObjects, getDisguiseId, getDisguiseName, getNumberOfBuckets, hasAssetBucket
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

BY_NAME

public static final int BY_NAME
See Also:
Constant Field Values

BY_LABEL

public static final int BY_LABEL
See Also:
Constant Field Values

BY_ID

public static final int BY_ID
See Also:
Constant Field Values

BY_INDEX

public static final int BY_INDEX
See Also:
Constant Field Values

bucketExtend

private com.flexstor.ejb.bucket.persist.ServerBucketExtendData bucketExtend
Constructor Detail

BucketHelper

public BucketHelper(java.lang.String sDisguiseName)
             throws DisguiseLoaderException
Loads the global disguise if it wasn't loaded previously


BucketHelper

public BucketHelper(int nDisguiseId)
             throws DisguiseLoaderException
Loads the global disguise if it wasn't loaded previously

Method Detail

loadBucket

private boolean loadBucket(int nBucketDesc,
                           int nMode)
Load a bucket to be used during subsequent method calls


loadBucket

private boolean loadBucket(java.lang.String sBucketDesc,
                           int nMode)
Load a bucket to be used during subsequent method calls


getBucketId

public int getBucketId(java.lang.String sBucketDesc,
                       int nMode)
Retrieve the id of a bucket based on either the bucket name or label


getBucketId

public int getBucketId(int nBucketIndex)
Retrieve the id of a bucket based on its index


getBucketType

public int getBucketType(java.lang.String sBucketDesc,
                         int nMode)
Retrieve the bucket type based on either the bucket name or label


getBucketType

public int getBucketType(int nBucketDesc,
                         int nMode)
Retrieve the bucket type based on the bucket id or index


getBucketLevel

public int getBucketLevel(java.lang.String sBucketDesc,
                          int nMode)
Retrieve the bucket level based on either the bucket name or label


getBucketLevel

public int getBucketLevel(int nBucketDesc,
                          int nMode)
Retrieve the bucket level based on the bucket id or index


getFieldExtendDataObject

public com.flexstor.ejb.field.persist.ServerFieldExtendData getFieldExtendDataObject(int nBucketDesc,
                                                                                     int nBucketMode,
                                                                                     int nFieldDesc,
                                                                                     int nFieldMode)
Retrieve the ServerFieldExtendData based on either the field id or index


getFieldExtendDataObject

public com.flexstor.ejb.field.persist.ServerFieldExtendData getFieldExtendDataObject(java.lang.String sBucketDesc,
                                                                                     int nBucketMode,
                                                                                     int nFieldDesc,
                                                                                     int nFieldMode)
Retrieve the ServerFieldExtendData based on either the field id or index


getFieldExtendDataObject

private com.flexstor.ejb.field.persist.ServerFieldExtendData getFieldExtendDataObject(int nFieldDesc,
                                                                                      int nFieldMode)
Retrieve the ServerFieldExtendData based on either the field id or index


getFieldExtendDataObject

public com.flexstor.ejb.field.persist.ServerFieldExtendData getFieldExtendDataObject(java.lang.String sBucketDesc,
                                                                                     int nBucketMode,
                                                                                     java.lang.String sFieldDesc,
                                                                                     int nFieldMode)
Retrieve the ServerFieldExtendData based on either the field name or label


getFieldExtendDataObject

public com.flexstor.ejb.field.persist.ServerFieldExtendData getFieldExtendDataObject(int nBucketDesc,
                                                                                     int nBucketMode,
                                                                                     java.lang.String sFieldDesc,
                                                                                     int nFieldMode)
Retrieve the ServerFieldExtendData based on either the field name or label


getFieldExtendDataObject

private com.flexstor.ejb.field.persist.ServerFieldExtendData getFieldExtendDataObject(java.lang.String sFieldDesc,
                                                                                      int nFieldMode)
Retrieve the ServerFieldExtendData based on either the field name or label


getFieldId

public int getFieldId(java.lang.String sBucketDesc,
                      int nBucketMode,
                      java.lang.String sFieldDesc,
                      int nFieldMode)
Retrieve the field id of a bucket based on either the field name or label


getFieldId

public int getFieldId(int nBucketDesc,
                      int nBucketMode,
                      java.lang.String sFieldDesc,
                      int nFieldMode)
Retrieve the field id of a bucket based on either the field name or label


getFieldId

private int getFieldId(java.lang.String sFieldDesc,
                       int nFieldMode)
This method assumes that bucketExtend is already loaded with a valid ServerBucketExtendData object.


getFieldLabel

public java.lang.String getFieldLabel(int nBucketDesc,
                                      int nBucketMode,
                                      int nFieldDesc,
                                      int nFieldMode)
Retrieve the field label of a bucket based on either the field id or index


getFieldLabel

public java.lang.String getFieldLabel(java.lang.String sBucketDesc,
                                      int nBucketMode,
                                      int nFieldDesc,
                                      int nFieldMode)
Retrieve the field label of a bucket based on either the field id or index


getFieldLabel

private java.lang.String getFieldLabel(int nFieldDesc,
                                       int nFieldMode)
This method assumes that bucketExtend is already loaded with a valid ServerBucketExtendData object.


getFieldData

public java.lang.String getFieldData(java.lang.String sBucketDesc,
                                     int nBucketMode,
                                     java.lang.String sFieldDesc,
                                     int nFieldMode,
                                     com.flexstor.common.data.ejb.search.SkeletonData skelData,
                                     com.flexstor.common.data.ejb.search.SkeletonFieldData skelField)
Get the field value stored in a SkeletonData object


getFieldData

public java.lang.String getFieldData(int nBucketDesc,
                                     int nBucketMode,
                                     java.lang.String sFieldDesc,
                                     int nFieldMode,
                                     com.flexstor.common.data.ejb.search.SkeletonData skelData,
                                     com.flexstor.common.data.ejb.search.SkeletonFieldData skelField)
Get the field value stored in a SkeletonData object


getFieldData

private java.lang.String getFieldData(java.lang.String sFieldDesc,
                                      int nFieldMode,
                                      com.flexstor.common.data.ejb.search.SkeletonData skelData,
                                      com.flexstor.common.data.ejb.search.SkeletonFieldData skelField)
This method assumes that bucketExtend is already loaded with a valid ServerBucketExtendData object.


getFieldIds

public int[] getFieldIds(int nBucketDesc,
                         int nBucketMode)
Retrieve an array of all field ids of a bucket based on either the field name or label


getFieldIds

public int[] getFieldIds(java.lang.String sBucketDesc,
                         int nBucketMode)
Retrieve an array of all field ids of a bucket based on either the field name or label


getFieldIds

private int[] getFieldIds()
This method assumes that bucketExtend is already loaded with a valid ServerBucketExtendData object.


getFieldIndex

public int getFieldIndex(java.lang.String sBucketDesc,
                         int nBucketMode,
                         java.lang.String sFieldDesc,
                         int nFieldMode)
Retrieve the field index of a bucket based on either the field name or label


getFieldIndex

public int getFieldIndex(int nBucketDesc,
                         int nBucketMode,
                         java.lang.String sFieldDesc,
                         int nFieldMode)
Retrieve the field index of a bucket based on either the field name or label


getFieldIndex

private int getFieldIndex(java.lang.String sFieldDesc,
                          int nFieldMode)
This method assumes that bucketExtend is already loaded with a valid ServerBucketExtendData object.


getAssetSkeletonFieldIds

public int[] getAssetSkeletonFieldIds()
Retrieve a list of field ids used as the skeleton fields for an asset