sapphire.util

Class SDIList

java.lang.Object

sapphire.util.SDIList

All Implemented Interfaces:

com.labvantage.sapphire.gwt.shared.JSONable, java.io.Serializable

public class SDIList
extends java.lang.Object
implements com.labvantage.sapphire.gwt.shared.JSONable, java.io.Serializable

SDIList - holds and manages a list of SDIs

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SDIList.KeyId

Field Summary

Fields inherited from interface com.labvantage.sapphire.gwt.shared.JSONable

TYPE_SUFFIX

Constructor Summary

Constructors

Constructor and Description
SDIList()

Method Summary

Modifier and Type	Method and Description
int	addSDI(java.lang.String keyid1) Adds a single keyed SDI to the list
int	addSDI(java.lang.String keyid1, java.lang.String keyid2, java.lang.String keyid3) Adds a multi-keyed SDI to the list
int	addSDIList(java.lang.String keyid1) Add a list of single key SDIs to the list
int	addSDIList(java.lang.String keyid1, java.lang.String keyid2, java.lang.String keyid3) Add a list of multi-key SDIs to the list
int	addSDIList(java.lang.String keyid1, java.lang.String keyid2, java.lang.String keyid3, java.lang.String delimeter) Add a list of multi-key SDIs to the list
java.lang.String	getKeyid(int index)
java.lang.String	getKeyid1() Returns a semi-colon separated list of keyid1
java.lang.String	getKeyid1(int index) Returns a specific keyid1 in the list
java.lang.String	getKeyid2() Returns a semi-colon separated list of keyid2
java.lang.String	getKeyid2(int index) Returns a specific keyid2 in the list
java.lang.String	getKeyid3() Returns a semi-colon separated list of keyid3
java.lang.String	getKeyid3(int index) Returns a specific keyid3 in the list
int	getListIndex(java.lang.String keyid1, java.lang.String keyid2, java.lang.String keyid3) Returns the index in the list of a specific SDI
java.lang.String	getSdcid() Returns the sdcid for the list of SDIs
java.lang.String	getSDIAttribute(int index, java.lang.String attributeid) Returns a specific SDI attribute value
java.lang.String	getSDIAttributeList(java.lang.String attributeid) Returns a list of attribute values for the SDIs in the list
java.lang.String	getSDIAttributeList(java.lang.String attributeid, java.lang.String delimeter) Returns a list of attribute values for the SDIs in the list
java.lang.String	getSDIList()
java.lang.String	getSDIList(SDIList.KeyId keyId) Returns a semi-colon separated list of keyid
java.lang.String	getSDIList(SDIList.KeyId keyId, java.lang.String delimeter) Returns a semi-colon separated list of keyid
java.lang.String	getSDIList(java.lang.String delimeter)
void	removeSDI(int index) Removes a specific SDI from the list
boolean	removeSDI(java.lang.String keyid1) Removes a specific SDI from the list
boolean	removeSDI(java.lang.String keyid1, java.lang.String keyid2, java.lang.String keyid3) Removes a specific SDI from the list
void	setAllowDups(boolean allowDups) Determines if duplicate SDIs can exist - default is false
void	setJSONObject(org.json.JSONObject jsonObject) Sets up the list with the JSON object definition
void	setSdcid(java.lang.String sdcid) Sets the sdcid for the lists of SDIs
void	setSDIAttribute(int index, java.lang.String attributeid, java.lang.String attributevalue) Sets a specific SDI attribute value
int	size() Returns the number of SDIs in the object
DataSet	toDataSet()
org.json.JSONObject	toJSONObject() Returns the list as a JSON object
java.lang.String	toJSONString() Returns the list as a JSON String
java.lang.String	toString()
java.lang.String	toString(java.lang.String delimeter)
java.lang.String	toText()

Methods inherited from class java.lang.Object

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

Constructor Detail

SDIList

public SDIList()

Method Detail

setSdcid

public void setSdcid(java.lang.String sdcid)

Sets the sdcid for the lists of SDIs

Parameters:

sdcid - the sdcid

getSdcid

public java.lang.String getSdcid()

Returns the sdcid for the list of SDIs

Returns:

the sdcid

toJSONObject

public org.json.JSONObject toJSONObject()

Returns the list as a JSON object

Returns:

the JSON object

toJSONString

public java.lang.String toJSONString()

Returns the list as a JSON String

Specified by:

toJSONString in interface com.labvantage.sapphire.gwt.shared.JSONable

Returns:

the JSON string

toString

public java.lang.String toString(java.lang.String delimeter)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toText

public java.lang.String toText()

toDataSet

public DataSet toDataSet()

setJSONObject

public void setJSONObject(org.json.JSONObject jsonObject)

Sets up the list with the JSON object definition

Parameters:

jsonObject - the JSON object

setAllowDups

public void setAllowDups(boolean allowDups)

Determines if duplicate SDIs can exist - default is false

Parameters:

allowDups - defines if dups are allowed

size

public int size()

Returns the number of SDIs in the object

Returns:

the number of SDIs

getSDIList

public java.lang.String getSDIList(SDIList.KeyId keyId,
                                   java.lang.String delimeter)

Returns a semi-colon separated list of keyid

Parameters:

keyId - defines the keyid to be returned

delimeter - the delimeter for the items

Returns:

keyid list

getSDIList

public java.lang.String getSDIList(SDIList.KeyId keyId)

Returns a semi-colon separated list of keyid

Parameters:

keyId - defines the keyid to be returned

Returns:

keyid list

getSDIList

public java.lang.String getSDIList()

getSDIList

public java.lang.String getSDIList(java.lang.String delimeter)

getKeyid

public java.lang.String getKeyid(int index)

getKeyid1

public java.lang.String getKeyid1(int index)

Returns a specific keyid1 in the list

Parameters:

index - index in the list to return

Returns:

the keyid1

getKeyid1

public java.lang.String getKeyid1()

Returns a semi-colon separated list of keyid1

Returns:

the keyid1

getKeyid2

public java.lang.String getKeyid2(int index)

Returns a specific keyid2 in the list

Parameters:

index - index in the list to return

Returns:

the keyid2

getKeyid2

public java.lang.String getKeyid2()

Returns a semi-colon separated list of keyid2

Returns:

the keyid2

getKeyid3

public java.lang.String getKeyid3(int index)

Returns a specific keyid3 in the list

Parameters:

index - index in the list to return

Returns:

the keyid3

getKeyid3

public java.lang.String getKeyid3()

Returns a semi-colon separated list of keyid3

Returns:

the keyid3

addSDIList

public int addSDIList(java.lang.String keyid1)

Add a list of single key SDIs to the list

Parameters:

keyid1 - the keyid1 list separated by a semi-colon

Returns:

the number of SDIs added

addSDIList

public int addSDIList(java.lang.String keyid1,
                      java.lang.String keyid2,
                      java.lang.String keyid3)

Add a list of multi-key SDIs to the list

Parameters:

keyid1 - the keyid1 list separated by a semi-colon

keyid2 - the keyid2 list separated by a semi-colon

keyid3 - the keyid3 list separated by a semi-colon

Returns:

the number of SDIs added

addSDIList

public int addSDIList(java.lang.String keyid1,
                      java.lang.String keyid2,
                      java.lang.String keyid3,
                      java.lang.String delimeter)

Add a list of multi-key SDIs to the list

Parameters:

keyid1 - the keyid1 list separated by a defined delimeter

keyid2 - the keyid2 list separated by a defined delimeter

keyid3 - the keyid3 list separated by a defined delimeter

delimeter - the delimeter for the keyids

Returns:

the number of SDIs added

addSDI

public int addSDI(java.lang.String keyid1)

Adds a single keyed SDI to the list

Parameters:

keyid1 - the keyid1

Returns:

the index in the list of the new SDI added

addSDI

public int addSDI(java.lang.String keyid1,
                  java.lang.String keyid2,
                  java.lang.String keyid3)

Adds a multi-keyed SDI to the list

Parameters:

keyid1 - the keyid1

keyid2 - the keyid2

keyid3 - the keyid3

Returns:

the index in the list of the new SDI added

getSDIAttributeList

public java.lang.String getSDIAttributeList(java.lang.String attributeid)

Returns a list of attribute values for the SDIs in the list

Parameters:

attributeid - the attribute to list

Returns:

the list of attribute values separated by a semi-colon

getSDIAttributeList

public java.lang.String getSDIAttributeList(java.lang.String attributeid,
                                            java.lang.String delimeter)

Returns a list of attribute values for the SDIs in the list

Parameters:

attributeid - the attribute to list

delimeter - the delimeter for the attribute values

Returns:

the list of attribute values separated by a defined attribute

getSDIAttribute

public java.lang.String getSDIAttribute(int index,
                                        java.lang.String attributeid)

Returns a specific SDI attribute value

Parameters:

index - the index of the SDI in the list

attributeid - the attribute value to return

Returns:

the attribute value

setSDIAttribute

public void setSDIAttribute(int index,
                            java.lang.String attributeid,
                            java.lang.String attributevalue)

Sets a specific SDI attribute value

Parameters:

index - the index of the SDi in the list

attributeid - the attributeid to set

attributevalue - the attribute value

getListIndex

public int getListIndex(java.lang.String keyid1,
                        java.lang.String keyid2,
                        java.lang.String keyid3)

Returns the index in the list of a specific SDI

Parameters:

keyid1 - the keyid1

keyid2 - the keyid2

keyid3 - the keyid3

Returns:

the index

removeSDI

public boolean removeSDI(java.lang.String keyid1,
                         java.lang.String keyid2,
                         java.lang.String keyid3)

Removes a specific SDI from the list

Parameters:

keyid1 - the keyid1

keyid2 - the keyid2

keyid3 - the keyid3

Returns:

true if the item was found and removed

removeSDI

public boolean removeSDI(java.lang.String keyid1)

Removes a specific SDI from the list

Parameters:

keyid1 - the keyid1

Returns:

true if the item was found and removed

removeSDI

public void removeSDI(int index)

Removes a specific SDI from the list

Parameters:

index - the index in the list