sapphire.util

Class SDIDataStore

java.lang.Object

sapphire.util.SDIDataStore

All Implemented Interfaces:

com.labvantage.sapphire.services.DDTConstants

public class SDIDataStore
extends java.lang.Object
implements com.labvantage.sapphire.services.DDTConstants

This class wraps an SDIData object can converts each of its DataSet into DataStores. In this way, modifications to the contents of the SDIData can be tracked. If the SDIData holds any nested SDIDatas (e.g. for child SDIs) then the nested SDIDatas are converted to SDIDataStore objects too. See details of the SDIData and DataStore object for additional information.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATASETNAME
static java.lang.String	DATASETNAMES
static java.lang.String	DATASETS
static java.lang.String	KEYS
static java.lang.String	SDIDATASTORENAMES
static java.lang.String	SDIDATASTORES
static java.lang.String	TYPES
static java.lang.String	UPDATEABLE

Fields inherited from interface com.labvantage.sapphire.services.DDTConstants

ACCESSCONTROLLEDFLAG, ACTIVEABLEFLAG, ADDRESSESFLAG, ALIASABLEFLAG, ALLOWATTRIBUTESFLAG, APPROVALDATE, ATTACHMENTSFLAG, ATTRIBUTE_ALLOWDUPLICATESFLAG, ATTRIBUTE_ALWAYSADDCOUNT, ATTRIBUTE_ALWAYSADDFLAG, ATTRIBUTE_ATTRIBUTEGROUP, ATTRIBUTE_ATTRIBUTEID, ATTRIBUTE_ATTRIBUTETITLE, ATTRIBUTE_DATATYPE, ATTRIBUTE_DEFAULTCLOBVALUE, ATTRIBUTE_DEFAULTDATEVALUE, ATTRIBUTE_DEFAULTNUMERICVALUE, ATTRIBUTE_DEFAULTTEXTVALUE, ATTRIBUTE_EDITORSTYLEID, ATTRIBUTE_EDITREFTYPEID, ATTRIBUTE_EDITSDCID, ATTRIBUTE_HELPTEXT, ATTRIBUTE_INSTRUCTIONFLAG, ATTRIBUTE_INSTRUCTIONTEXT, ATTRIBUTES, AUDITEDFLAG, AUDITPROMPTFLAG, CATEGORIESFLAG, CHANGECONTROLLEDFLAG, CHARGEOPTIONFLAG, COCABLEFLAG, COLUMN_COLUMNDESC, COLUMN_COLUMNDOC, COLUMN_COLUMNID, COLUMN_COLUMNLABEL, COLUMN_COLUMNLENGTH, COLUMN_DATATYPE, COLUMN_EDITORSTYLEID, COLUMN_EDITORSTYLEPROPS, COLUMN_KEYGENERATIONRULE, COLUMN_LINK, COLUMN_PKFLAG, COLUMN_SEARCHABLEFLAG, COLUMN_TIMEZONEINDEPENDENT, COLUMNLINK_ID, COLUMNLINK_LINKSDCID, COLUMNLINK_REFTYPEID, COLUMNLINK_SDCCOLUMNID, COLUMNLINK_SDCCOLUMNID2, COLUMNLINK_SDCCOLUMNID3, COLUMNLINK_TYPE, COLUMNLINK_VERSIONEDFLAG, COLUMNS, COMPCODE, COMPONENTABLEFLAG, COORDINATABLEFLAG, DATAENTRYFLAG, DATATYPE_BLOB, DATATYPE_CHAR, DATATYPE_CLOB, DATATYPE_DATE, DATATYPE_NUMBER, DATATYPE_REAL, DEFAULTMASKINGLEVEL, DELETEFLAG_BLOCK, DELETEFLAG_DELETE, DELETEFLAG_NULL, DESCCOL, DESCRIPTION, DETAILLINK_DELETEFLAG, DETAILLINK_DETAILLINKID, DETAILLINK_ITEMDISPLAY, DETAILLINK_LINKID, DETAILLINK_LINKSDCID, DETAILLINK_LINKSEQUENCE, DETAILLINK_LINKTABLEID, DETAILLINK_LINKTYPE, DETAILLINK_REFTYPEID, DETAILLINK_SDCCOLUMNID, DETAILLINK_SDCCOLUMNID2, DETAILLINK_SDCCOLUMNID3, DETAILLINK_SDCID, DETAILLINK_TABLEID, DETAILLINK_TABLELABLE, DETAILLINKS, EFFECTIVITYDATE, EFFECTIVITYDATEFLAG, ITEMDISPLAY, KEYCOLID1, KEYCOLID2, KEYCOLID3, KEYCOLUMNS, KEYGENERATIONRULE, KEYIDUSABLESIZE, KEYMAP1, LICENCEMAX, LINK_COLUMNS, LINK_DELETEFLAG, LINK_DETAILLINK, LINK_HASUSERSEQUENCE, LINK_KEYCOLID1, LINK_KEYCOLID2, LINK_KEYCOLID3, LINK_KEYCOLID4, LINK_KEYCOLID5, LINK_KEYCOLUMNS, LINK_LINKID, LINK_LINKITEMDISPLAY, LINK_LINKSDCCOLUMNID, LINK_LINKSDCID, LINK_LINKSEQUENCE, LINK_LINKTABLEID, LINK_LINKTABLELABEL, LINK_LINKTYPE, LINK_LOADFLAG, LINK_LOOKUPPAGEID, LINK_REFTYPEID, LINK_SDCCOLUMNID, LINK_SDCCOLUMNID2, LINK_SDCCOLUMNID3, LINK_SDCID, LINK_TABLEID, LINKCOLUMN_COLUMNID, LINKCOLUMN_COLUMNLABEL, LINKCOLUMN_COLUMNLENGTH, LINKCOLUMN_DATATYPE, LINKCOLUMN_LINK, LINKCOLUMN_PKFLAG, LINKCOLUMN_TABLEID, LINKS, MASKABLEFLAG, MASKDATAVISIBILITYLINK, MASKDATAVISIBILITYRULE, NOTESFLAG, ORDERABLEFLAG, PARENTTABLEID, PARTITIONEDFLAG, PARTITIONRULE, PLANNABLEFLAG, PLURAL, PRICELISTFLAG, PSEUDOKEYCOLUMN, REFTYPEID, REQUIREDATTRIBUTESFLAG, REVERSEDETAILLINKS, REVERSELINKS, SCHEDULEABLEFLAG, SDCID, SDCOPERATION_MANAGEATTACHMENT, SDCOPERATION_VIEWATTACHMENT, SDCOPERATION_VIEWMASKEDDATA, SDCTYPE, SEARCHABLEFLAG, SECURITYFLAG, SENSITIVEDATAFLAG, SINGULAR, SPECFLAG, STANDARDEXPORT, STANDARDMAINTFLAG, TABLEID, TABLEIDMAP, TABLELABEL, TABLES, TEMPLATABLEFLAG, UUIDFLAG, VERSIONAPPROVALTYPEID, VERSIONEDFLAG, WORKFLOWFLAG, WORKITEMFLAG

Constructor Summary

Constructors

Constructor and Description
SDIDataStore(JsonObject jso) Constructs a new SDIDataStore that was previously serialized with .toJsonObject()
SDIDataStore(JsonObject jso, com.labvantage.sapphire.services.ConnectionInfo connectionInfo)
SDIDataStore(SDIData sdiData) Constructs a new SDIDataStore, wrapping the provided SDIData.

Method Summary

Modifier and Type	Method and Description
SDIDataStore	findSDIDataStore(java.lang.String sdcid)
java.util.List<java.lang.String>	getDataSetNames() Returns the list of datasetnames held in the wrapped SDIData
DataStore	getDataStore(java.lang.String datasetName) Fetches the specified DataStore
java.lang.String[]	getKeys(java.lang.String datasetName) Convenience method to fetch the primary keys for the specified DataStore
java.lang.String	getLinkid() The LinkId if this is wraps a nested SDIData
java.lang.String	getSdcid() The SDC for the wrapped SDIData
SDIDataStore	getSDIDataStore(java.lang.String name) Returns a nested SDIDataStore
java.util.List<java.lang.String>	getSDIDataStoreNames() Returns the list of datasetnames held in the wrapped SDIData
JsonObject	toJsonObject() Serialized the SDIDataStore object
SDIData	toSDIData()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEYS

public static final java.lang.String KEYS

See Also:

Constant Field Values

TYPES

public static final java.lang.String TYPES

See Also:

Constant Field Values

SDIDATASTORES

public static final java.lang.String SDIDATASTORES

See Also:

Constant Field Values

SDIDATASTORENAMES

public static final java.lang.String SDIDATASTORENAMES

See Also:

Constant Field Values

DATASETS

public static final java.lang.String DATASETS

See Also:

Constant Field Values

DATASETNAME

public static final java.lang.String DATASETNAME

See Also:

Constant Field Values

DATASETNAMES

public static final java.lang.String DATASETNAMES

See Also:

Constant Field Values

UPDATEABLE

public static final java.lang.String UPDATEABLE

See Also:

Constant Field Values

Constructor Detail

SDIDataStore

public SDIDataStore(SDIData sdiData)

Constructs a new SDIDataStore, wrapping the provided SDIData. Note that pre-existing rows in any of the datasets do NOT pick up an Insert status. Only rows inserted (or updated) via methods in this class get flagged.

SDIDataStore

public SDIDataStore(JsonObject jso)
             throws org.json.JSONException

Constructs a new SDIDataStore that was previously serialized with .toJsonObject()

Throws:

org.json.JSONException

SDIDataStore

public SDIDataStore(JsonObject jso,
                    com.labvantage.sapphire.services.ConnectionInfo connectionInfo)
             throws org.json.JSONException

Throws:

org.json.JSONException

Method Detail

toSDIData

public SDIData toSDIData()

toJsonObject

public JsonObject toJsonObject()
                        throws SapphireException

Serialized the SDIDataStore object

Throws:

SapphireException

getDataStore

public DataStore getDataStore(java.lang.String datasetName)

Fetches the specified DataStore

getKeys

public java.lang.String[] getKeys(java.lang.String datasetName)

Convenience method to fetch the primary keys for the specified DataStore

getSdcid

public java.lang.String getSdcid()

The SDC for the wrapped SDIData

getLinkid

public java.lang.String getLinkid()

The LinkId if this is wraps a nested SDIData

getDataSetNames

public java.util.List<java.lang.String> getDataSetNames()

Returns the list of datasetnames held in the wrapped SDIData

getSDIDataStoreNames

public java.util.List<java.lang.String> getSDIDataStoreNames()

Returns the list of datasetnames held in the wrapped SDIData

getSDIDataStore

public SDIDataStore getSDIDataStore(java.lang.String name)

Returns a nested SDIDataStore

findSDIDataStore

public SDIDataStore findSDIDataStore(java.lang.String sdcid)