sapphire.util

Class SDIData

java.lang.Object

sapphire.util.SDIData

All Implemented Interfaces:

com.labvantage.sapphire.gwt.shared.constants.DatasetNameConstants, java.io.Serializable

public class SDIData
extends java.lang.Object
implements java.io.Serializable, com.labvantage.sapphire.gwt.shared.constants.DatasetNameConstants

Class used to hold information about SDIs and their related detail tables. The class it typically populated by first populating an SDIRequest object and passing it to the SDIProcessor. This returns a populated SDIData class. The SDIData class is essentially a collection of DataSets, each representing an SDI releated table that was requested through the SDIRequest object. Methods are provided to access these DataSets through datasetnames as defined in the original SDIRequest object.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.LinkedHashMap	linkedSDIData
protected java.util.LinkedHashMap	sdiData

Fields inherited from interface com.labvantage.sapphire.gwt.shared.constants.DatasetNameConstants

ADDRESS, ALL, APPROVAL, APPROVALSTEP, ATTACHMENT, ATTACHMENTATTRIBUTE, ATTACHMENTOPERATION, ATTRIBUTE, CALENDAR, CATEGORY, COC, DATA_LOCK_FAILURE, DATAAPPROVAL, DATACAPTURE, DATAITEM, DATAITEMATTRIBUTE, DATALIMIT, DATARELATION, DATASET, DATASETATTRIBUTE, DATASPEC, DOCUMENT, EVENTPLANHISTORY, FORMRULE, NOTES, PRICELIST, PRIMARY, PRIMARY_AND_DATA_LOCK_FAILURE, PRIMARY_LOCK_FAILURE, PRIMARYKEYS, REAGENTRELATION, ROLE, SDIALIAS, SDIEVENTPLAN, SDIEVENTPLANITEM, SDIEVENTPLANITEMPROPERTY, SDISPEC, SDISPECRULE, SDIWORKFLOWRULE, SDIWORKITEM, SDIWORKITEMATTRIBUTE, SDIWORKITEMITEM, SDIWORKSHEETRULE, WORKITEMRELATION

Constructor Summary

Constructors

Constructor and Description
SDIData() Default constructor
SDIData(java.lang.String sdcid)
SDIData(java.lang.String[] primarykeycols) Internal constructor, not currently supported.
SDIData(java.lang.String keycolid1, java.lang.String keycolid2, java.lang.String keycolid3) Internal constructor, not currently supported.
SDIData(java.lang.String sdcid, java.lang.String keycolid1, java.lang.String keycolid2, java.lang.String keycolid3)

Method Summary

Modifier and Type	Method and Description
DataSet	getDataset(java.lang.String datasetname) Returns a sapphire.util.SDIData for the specified dataset name
static java.lang.String	getDatasetCode(java.lang.String datasetname) Return the dataset code for a given dataset name.
static java.lang.String[]	getDatasetCodes() Returns the full list of dataset codes currently recognized by the SDIData and SDIRequest classes.
java.lang.String[]	getDataSetKeys(java.lang.String datasetName)
static java.lang.String	getDatasetName(java.lang.String datasetcode) Return the dataset name for a given dataset code.
static java.lang.String	getDatasetNameByTableName(java.lang.String tablename) Return the dataset name for a given table name.
static java.lang.String[]	getDatasetNames() Returns the full list of dataset names currently recognized by the SDIData and SDIRequest classes.
java.util.Set	getDatasets() Returns the datanames of all datasets currently populated.
static java.lang.String	getDatasetTablename(java.lang.String datasetname) Return the dataset table name for a given datasetname.
static java.lang.String[]	getDatasetTables() Internal method, not currently supported.
java.lang.String	getDetailDetailLinkid(java.lang.String linktable)
java.lang.String	getDetailLinkid(java.lang.String linktable)
java.lang.String[]	getDetailLinkTableKeys(java.lang.String linktable) Internal method, not currently supported.
java.lang.String[]	getDetailLinkTables() Internal method, not currently supported.
java.lang.String[]	getKeys(java.lang.String datasetname) Returns the key columns for the specified dataset name.
java.lang.String	getLinkid(java.lang.String linktable) Internal method, not currently supported.
java.lang.String[]	getLinkTableKeys(java.lang.String linktable) Internal method, not currently supported.
java.lang.String[]	getLinkTables() Internal method, not currently supported.
java.lang.String	getPrimaryFKRsetid(java.lang.String primaryfkcolumnid)
java.lang.String	getPrimaryRsetid() Returns the Rsetid that was used to populate the SDIData.
int	getQualifiedRows() Returns the actual qualified SDIs according to SDIRequest.
int	getRequestStatus() Internal method, not currently supported.
java.lang.String	getRsetid() Returns the Rsetid that was used to populate the SDIData.
java.lang.String	getSdcid()
java.util.Set	getSDIData() Returns the datanames of all additional linked SDIData currently populated.
SDIData	getSDIData(java.lang.String sdidataname) Returns a sapphire.util.DataSet for the specified dataset name
void	removeDataset(java.lang.String datasetname)
void	sanitizeDataset(java.lang.String datasetname, java.lang.String sysuserid, java.lang.String tool, java.util.Calendar now) Internal method, not currently supported.
void	sanitizeDataset(java.lang.String datasetname, java.lang.String sysuserid, java.lang.String tool, java.util.Calendar now, PropertyList props) Internal method, not currently supported.
void	setDataset(java.lang.String dataset, DataSet ds) Internal method, not currently supported.
void	setDataset(java.lang.String dataset, java.sql.ResultSet rs) Internal method, not currently supported.
void	setDataSetKeys(java.lang.String[][] dataSetKeys)
void	setDetailLinks(java.lang.String[] linkIds, java.lang.String[] detailLinkIds, java.lang.String[] linktables) Internal method, not currently supported.
void	setDetailLinkTableKeys(java.lang.String linktable, java.lang.String[] keys) Internal method, not currently supported.
void	setKeys(java.lang.String datasetname, java.lang.String keyid1, java.lang.String keyid2, java.lang.String keyid3)
void	setLinks(java.lang.String[] linkids, java.lang.String[] linktables) Internal method, not currently supported.
void	setLinkTableKeys(java.lang.String linktable, java.lang.String[] keys) Internal method, not currently supported.
void	setPrimaryFKRsetid(java.lang.String primaryfkcolumnid, java.lang.String rsetId)
void	setPrimaryKeyCols(java.lang.String keycolid1, java.lang.String keycolid2, java.lang.String keycolid3)
void	setQualifiedRows(int rows) Internal method, not currently supported.
void	setRequestStatus(int status) Internal method, not currently supported.
void	setRsetid(java.lang.String rsetid) Internal method, not currently supported.
void	setSdcid(java.lang.String sdcid)
boolean	setSDIData(java.lang.String xmlString)
void	setSDIData(java.lang.String dataname, SDIData sdiData) Internal method, not currently supported.
org.json.JSONObject	toJSONObject()
java.lang.String	toJSONString()
java.lang.String	toXML()
java.lang.String	toXML(int indentFactor, boolean ignoreEmpty)

Methods inherited from class java.lang.Object

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

Field Detail

sdiData

protected java.util.LinkedHashMap sdiData

linkedSDIData

protected java.util.LinkedHashMap linkedSDIData

Constructor Detail

SDIData

public SDIData()

Default constructor

SDIData

public SDIData(java.lang.String sdcid)

SDIData

public SDIData(java.lang.String keycolid1,
               java.lang.String keycolid2,
               java.lang.String keycolid3)

Internal constructor, not currently supported.

SDIData

public SDIData(java.lang.String sdcid,
               java.lang.String keycolid1,
               java.lang.String keycolid2,
               java.lang.String keycolid3)

SDIData

public SDIData(java.lang.String[] primarykeycols)

Internal constructor, not currently supported.

Method Detail

setSdcid

public void setSdcid(java.lang.String sdcid)

setPrimaryKeyCols

public void setPrimaryKeyCols(java.lang.String keycolid1,
                              java.lang.String keycolid2,
                              java.lang.String keycolid3)

getSdcid

public java.lang.String getSdcid()

setSDIData

public boolean setSDIData(java.lang.String xmlString)

setLinks

public void setLinks(java.lang.String[] linkids,
                     java.lang.String[] linktables)

Internal method, not currently supported.

setDetailLinks

public void setDetailLinks(java.lang.String[] linkIds,
                           java.lang.String[] detailLinkIds,
                           java.lang.String[] linktables)

Internal method, not currently supported.

setLinkTableKeys

public void setLinkTableKeys(java.lang.String linktable,
                             java.lang.String[] keys)

Internal method, not currently supported.

setDetailLinkTableKeys

public void setDetailLinkTableKeys(java.lang.String linktable,
                                   java.lang.String[] keys)

Internal method, not currently supported.

getLinkid

public java.lang.String getLinkid(java.lang.String linktable)

Internal method, not currently supported.

getDetailLinkid

public java.lang.String getDetailLinkid(java.lang.String linktable)

getDetailDetailLinkid

public java.lang.String getDetailDetailLinkid(java.lang.String linktable)

getLinkTableKeys

public java.lang.String[] getLinkTableKeys(java.lang.String linktable)

Internal method, not currently supported.

getDetailLinkTableKeys

public java.lang.String[] getDetailLinkTableKeys(java.lang.String linktable)

Internal method, not currently supported.

getLinkTables

public java.lang.String[] getLinkTables()

Internal method, not currently supported.

getDetailLinkTables

public java.lang.String[] getDetailLinkTables()

Internal method, not currently supported.

getKeys

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

Returns the key columns for the specified dataset name.

Parameters:

datasetname - the name of the dataset (e.g. primary, sdiaddress etc.)

Returns:

the array of keys for the dataset

getDatasetCode

public static java.lang.String getDatasetCode(java.lang.String datasetname)

Return the dataset code for a given dataset name.

Parameters:

datasetname - the dataset name (e.g. primary, dataset etc.)

Returns:

the corresponing two-letter code (e.g. pr, wf, ds etc.)

getDatasetName

public static java.lang.String getDatasetName(java.lang.String datasetcode)

Return the dataset name for a given dataset code.

Parameters:

datasetcode - the two-letter code (e.g. pr, wf, ds etc.)

Returns:

the corresponing dataset name (e.g. primary, dataset etc.)

getDatasetNameByTableName

public static java.lang.String getDatasetNameByTableName(java.lang.String tablename)

Return the dataset name for a given table name.

Parameters:

tablename - the table name

Returns:

the corresponing dataset name (e.g. primary, dataset etc.)

getDatasetTablename

public static java.lang.String getDatasetTablename(java.lang.String datasetname)

Return the dataset table name for a given datasetname.

Parameters:

datasetname - the dataset name (e.g. primary, dataset etc.)

Returns:

the corresponing dataset table name (e.g. sample, sdidata etc.)

getDatasetCodes

public static java.lang.String[] getDatasetCodes()

Returns the full list of dataset codes currently recognized by the SDIData and SDIRequest classes.

Returns:

the full list of dataset codes currently recognized by the SDIData and SDIRequest classes.

getDatasetNames

public static java.lang.String[] getDatasetNames()

Returns the full list of dataset names currently recognized by the SDIData and SDIRequest classes.

Returns:

the full list of dataset names currently recognized by the SDIData and SDIRequest classes.

getDatasetTables

public static java.lang.String[] getDatasetTables()

Internal method, not currently supported.

getDataSetKeys

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

setDataset

public void setDataset(java.lang.String dataset,
                       java.sql.ResultSet rs)

Internal method, not currently supported.

setDataset

public void setDataset(java.lang.String dataset,
                       DataSet ds)

Internal method, not currently supported.

removeDataset

public void removeDataset(java.lang.String datasetname)

setSDIData

public void setSDIData(java.lang.String dataname,
                       SDIData sdiData)

Internal method, not currently supported.

getDataset

public DataSet getDataset(java.lang.String datasetname)

Returns a sapphire.util.SDIData for the specified dataset name

Parameters:

datasetname - the dataset name for the DataSet required (e.g. primary, dataitem etc.)

Returns:

the DataSet requested

getSDIData

public SDIData getSDIData(java.lang.String sdidataname)

Returns a sapphire.util.DataSet for the specified dataset name

Parameters:

sdidataname - the dataname for the SDIData required (e.g. samples etc.)

Returns:

the SDIData requested

getSDIData

public java.util.Set getSDIData()

Returns the datanames of all additional linked SDIData currently populated.

Returns:

a set containing the list of dataset names currently populated.

getDatasets

public java.util.Set getDatasets()

Returns the datanames of all datasets currently populated.

Returns:

a set containing the list of dataset names currently populated.

setPrimaryFKRsetid

public void setPrimaryFKRsetid(java.lang.String primaryfkcolumnid,
                               java.lang.String rsetId)

getPrimaryFKRsetid

public java.lang.String getPrimaryFKRsetid(java.lang.String primaryfkcolumnid)

setRsetid

public void setRsetid(java.lang.String rsetid)

Internal method, not currently supported.

getRsetid

public java.lang.String getRsetid()

Returns the Rsetid that was used to populate the SDIData. This will only be a valid value if the SDIRequest was set to retain the Rsetid.

Returns:

the Rsetid that was used to populate the SDIData instance plus any FK column rset ids.

getPrimaryRsetid

public java.lang.String getPrimaryRsetid()

Returns the Rsetid that was used to populate the SDIData. This will only be a valid value if the SDIRequest was set to retain the Rsetid.

Returns:

the Rsetid that was used to populate the SDIData instance.

setQualifiedRows

public void setQualifiedRows(int rows)

Internal method, not currently supported.

getQualifiedRows

public int getQualifiedRows()

Returns the actual qualified SDIs according to SDIRequest. This value can be higher than the retrieved if the retrieve limit is set in SQIRequest.

Returns:

the actual qualified SDIs according to SDIRequest.

setRequestStatus

public void setRequestStatus(int status)

Internal method, not currently supported.

getRequestStatus

public int getRequestStatus()

Internal method, not currently supported.

sanitizeDataset

public void sanitizeDataset(java.lang.String datasetname,
                            java.lang.String sysuserid,
                            java.lang.String tool,
                            java.util.Calendar now)

Internal method, not currently supported.

sanitizeDataset

public void sanitizeDataset(java.lang.String datasetname,
                            java.lang.String sysuserid,
                            java.lang.String tool,
                            java.util.Calendar now,
                            PropertyList props)

Internal method, not currently supported.

setKeys

public void setKeys(java.lang.String datasetname,
                    java.lang.String keyid1,
                    java.lang.String keyid2,
                    java.lang.String keyid3)

toJSONObject

public org.json.JSONObject toJSONObject()

toJSONString

public java.lang.String toJSONString()

toXML

public java.lang.String toXML()

toXML

public java.lang.String toXML(int indentFactor,
                              boolean ignoreEmpty)

setDataSetKeys

public void setDataSetKeys(java.lang.String[][] dataSetKeys)