Copyright 2009,2010, Lapetus Systems Ltd. (All rights reserved)

com.lapetus_ltd.api.db.xml.types
Class TLptsDBStatementCriteriaItemType

java.lang.Object
  extended by com.lapetus_ltd._2009.xml.types.XLptsDBStatementCriteriaItemType
      extended by com.lapetus_ltd.api.db.xml.types.TLptsDBStatementCriteriaItemType

public class TLptsDBStatementCriteriaItemType
extends XLptsDBStatementCriteriaItemType

Class Description : This initialises the XLptsDBStatementCriteriaItemType.

This item is part of the list of TLptsDBStatementCriteriaType.getCriteriaListItem(). This class holds information
specific to one part of the WHERE or JOIN clause. It contains list so that an operation (like IN) can be accommodated with
many parameter values (SELECT * WHERE table.column IN ('1','2','3') etc).
There are lists for primaries (dynamic statement processing), joins and static values (WHERE A='static value').
About primaries (by the way, a primary statement is one that feeds data, one record at a time to another dynamically executing statement),
So when we add a primary item to a statement, then that statement becomes a dynamic statement, which means that it is executed every time
the primary row is changed and the resultset is then related to the primary on a one-to-many basis. The dynamic statement in turn can have
it's own dynamic statement(s), which means that it is also a primary statement, but it is not the top level primary.
Instead of setting the values in this class, it is easier to use the TLptsStatement.setPrimaryStatement(java.lang.String, boolean) & TLptsStatement.addPrimaryRelationship(int, int[], java.lang.String)
For the static and join clauses, one can set the values in here directly and then add them to TLptsDBStatementCriteriaType.addCriteriaListItem(com.lapetus_ltd._2009.xml.types.XLptsDBStatementCriteriaItemType).
Take a look at the examples below, and check out the example or test classes for code samples.

$LastChangedRevision: 1166 $
$LastChangedDate:: 2010-11-04 14:02:23#$


Field Summary
 
Fields inherited from class com.lapetus_ltd._2009.xml.types.XLptsDBStatementCriteriaItemType
andConnector, columnItem, id, joinLeftTable, joinOnListItem, joinOnUsingType, joinRightTable, joinType, joinUsingColumnListItem, operation, primaryColumnListItem, primaryIndexListItem, sqlIndex, staticStringListItem
 
Constructor Summary
TLptsDBStatementCriteriaItemType()
           This constructor initiates the Statement Parameter Item Type and initialises the lists.
TLptsDBStatementCriteriaItemType(XLptsDBStatementCriteriaItemType spit)
           This constructor copies the statement parameter information from an existing XLptsDBStatementCriteriaItemType.
 
Method Summary
 void addJoinOnListItem(XLptsDBStatementJoinType item)
           Adds the join item to the joinOnListItem list.
 void addJoinUsingColumnListItem(XLptsDBStatementColumnType item)
           Adds the column to the USING column list.
 void addPrimaryColumnListItem(XLptsDBStatementColumnType item)
           Adds the column to the criteria column list.
 void addPrimaryIndexListItem(java.lang.Integer item)
           Adds the primary index item to the primaryIndexListItem list.
 void addStaticStringListItem(java.lang.String item)
           Adds the static item to the staticStringListItem list.
 void clearJoinOnListItem()
           Clears the JOIN list (deletes all items).
 void clearJoinUsingColumnListItem()
           Clears the Criteria Column list.
 void clearPrimaryColumnListItem()
           Clears the Criteria Column list.
 void clearStaticStringListItem()
           Clear the staticStringListItem list.
 boolean equals(java.lang.Object obj)
           Check for equal TLptsDBStatementCriteriaItemType objects.
 java.util.List<XLptsDBStatementJoinType> getJoinOnListItem()
           Returns a copy of the actual list.
 int getJoinOnListItemSize()
           Returns the size of the actual list.
 java.util.List<XLptsDBStatementColumnType> getJoinUsingColumnListItem()
           Returns a copy of the join USING column list.
 XLptsDBStatementColumnType getJoinUsingColumnListItem(int index)
           Returns .
 int getJoinUsingColumnListItemSize()
           Returns the size of the actual list.
 java.util.List<XLptsDBStatementColumnType> getPrimaryColumnListItem()
           Returns a copy of the primary column list.
 XLptsDBStatementColumnType getPrimaryColumnListItem(int index)
           Returns .
 int getPrimaryColumnListItemSize()
           Returns the size of the actual list.
 java.util.List<java.lang.Integer> getPrimaryIndexListItem()
           Returns a copy of the actual list.
 int getPrimaryIndexListItemSize()
           Returns the size of the actual list.
 java.util.List<java.lang.String> getStaticStringListItem()
           Returns a copy of the actual list.
 int getStaticStringListItemSize()
           Returns the size of the actual list.
 void removeJoinOnListItem(int index)
           Removes the join item from the joinOnListItem list by index.
 void removeJoinOnListItem(XLptsDBStatementJoinType item)
           Removes the join item from the joinOnListItem list.
 void removeJoinUsingColumnListItem(int index)
           Removes the column from the criteria column list by index.
 void removeJoinUsingColumnListItem(XLptsDBStatementColumnType item)
           Removes the column from the criteria column list.
 void removePrimaryColumnListItem(int index)
           Removes the column from the criteria column list by index.
 void removePrimaryColumnListItem(XLptsDBStatementColumnType item)
           Removes the column from the criteria column list.
 void removePrimaryIndexListItem(java.lang.Integer item)
           Removes the primary index item from the primaryIndexListItem list.
 void removePrimaryIndexListItemByIndex(int index)
           Removes the primary index item from the primaryIndexListItem list by index.
 void removeStaticStringListItem(int index)
           Removes the static item from the staticStringListItem list by index.
 void removeStaticStringListItem(java.lang.String item)
           Removes the String item from the staticStringListItem list.
 
Methods inherited from class com.lapetus_ltd._2009.xml.types.XLptsDBStatementCriteriaItemType
getColumnItem, getId, getJoinLeftTable, getJoinOnUsingType, getJoinRightTable, getJoinType, getOperation, getSqlIndex, isAndConnector, setAndConnector, setColumnItem, setId, setJoinLeftTable, setJoinOnUsingType, setJoinRightTable, setJoinType, setOperation, setSqlIndex
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TLptsDBStatementCriteriaItemType

public TLptsDBStatementCriteriaItemType()

This constructor initiates the Statement Parameter Item Type and initialises the lists.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : Never.

Notes :

Example :


 TLptsStatement itemsStatement = new TLptsStatement(connection, XLptsDBTypeOfStatementType.SELECT);
 itemsStatement.getTableItemByName("items").setSelected(true);
 itemsStatement.getColumnItemByName("items","iditems").setSelected(true);
 itemsStatement.getCriteriaType().setType(XLptsDBCriteriaType.STATIC);
 
 TLptsDBStatementCriteriaItemType spit = new TLptsDBStatementCriteriaItemType();
 spit.setColumnItem(itemsStatement.getColumnItemByName("items","iditems"));  // table and column names
 spit.setOperation(TLptsFactoryStatement.OPERATION_LESS_THAN);
 spit.addStaticStringListItem("100");
 ((TLptsDBStatementCriteriaType) itemsStatement.getCriteriaType()).addCriteriaListItem(spit);

 itemsStatement.setTitle("items");
 itemsStatement.setExecutable(false); // we do not want to execute as a dynamic related statement will be added
 itemsId = itemsStatement.getId();
 System.out.println("SQL Statement " + itemsStatement.getTitle() + ": " + itemsStatement.getSqlStatementFormatted());
 TLptsFactoryStatement.createNewStatement(connection,itemsStatement);

 


TLptsDBStatementCriteriaItemType

public TLptsDBStatementCriteriaItemType(XLptsDBStatementCriteriaItemType spit)

This constructor copies the statement parameter information from an existing XLptsDBStatementCriteriaItemType.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : Never.

Notes : Use this function every time you need to copy or instantiate a type XLptsDBStatementCriteriaItemType class.

Example :


 public void example(XLptsDBStatementCriteriaItemType spit)
 {
   TLptsDBStatementCriteriaItemType criteriaType = new TLptsDBStatementCriteriaItemType(spit);
 }

 

Parameters:
spit - the class object to copy and create a new class object of this kind.
Method Detail

addJoinOnListItem

public void addJoinOnListItem(XLptsDBStatementJoinType item)

Adds the join item to the joinOnListItem list.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : n/a

Notes : Use this to add to the list. Getting the list with getJoinOnListItem and
then adding does not have any affect.

Example :


 TLptsDBStatementCriteriaItemType spit =  new TLptsDBStatementCriteriaItemType();
 TLptsDBStatementJoinType spjot = new TLptsDBStatementJoinType();
 spit.addJoinOnListItem(spjot);

 

Parameters:
item - the column to add in the list.

addJoinUsingColumnListItem

public void addJoinUsingColumnListItem(XLptsDBStatementColumnType item)

Adds the column to the USING column list.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : n/a

Notes : Use this to add to the list. Getting the list with getJoinUsingColumnListItem and
then adding does not have any affect.

Example :


 TLptsDBStatementCriteriaItemType spit =  new TLptsDBStatementCriteriaItemType();
 String columnName = "id";
 for(XLptsDBStatementColumnType column : spit.getJoinUsingColumnListItem())
   if(column.toString().equals(columnName))
   {
     spit.addJoinUsingColumnListItem(column);
     break;
   }

 

Parameters:
item - the column to add in the list.

addPrimaryColumnListItem

public void addPrimaryColumnListItem(XLptsDBStatementColumnType item)

Adds the column to the criteria column list.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : n/a

Notes : Use this to add to the list. Getting the list with getPrimaryColumnListItem and
then adding does not have any affect.

Example :


 TLptsDBStatementCriteriaItemType spit =  new TLptsDBStatementCriteriaItemType();
 TLptsDBStatementColumnType column = new TLptsDBStatementColumnType();
 spit.addPrimaryColumnListItem(column);

 

Parameters:
item - the column to add in the list.

addPrimaryIndexListItem

public void addPrimaryIndexListItem(java.lang.Integer item)

Adds the primary index item to the primaryIndexListItem list.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : n/a

Notes : Use this to add to the list. Getting the list with getPrimaryIndexListItem and
then adding does not have any affect.

Example :


 TLptsDBStatementCriteriaItemType spit =  new TLptsDBStatementCriteriaItemType();
 int primary = 5;
 spit.addPrimaryIndexListItem(primary);

 

Parameters:
item - the primary index to add in the list.

addStaticStringListItem

public void addStaticStringListItem(java.lang.String item)

Adds the static item to the staticStringListItem list.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : n/a

Notes : Use this to add to the list. Getting the list with getStaticStringListItem and
then adding does not have any affect.

Example :


 TLptsDBStatementCriteriaItemType spit =  new TLptsDBStatementCriteriaItemType();
 String static = "staticCriteria";
 spit.addStaticStringListItem(static);

 

Parameters:
item - the static string to add in the list.

clearJoinOnListItem

public void clearJoinOnListItem()

Clears the JOIN list (deletes all items).

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : Never.

Notes :

Example :


 


clearJoinUsingColumnListItem

public void clearJoinUsingColumnListItem()

Clears the Criteria Column list.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : n/a

Notes : Use this to clear the list. Getting the list with getJoinUsingColumnListItem and
then clear does not have any affect.

Example :


 TLptsDBStatementCriteriaItemType spit = new TLptsDBStatementCriteriaItemType();
 if(spit.getJoinUsingColumnListItemSize() > 0)
   spit.clearJoinUsingColumnListItem();

 


clearPrimaryColumnListItem

public void clearPrimaryColumnListItem()

Clears the Criteria Column list.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : n/a

Notes : Use this to clear the list. Getting the list with getPrimaryColumnListItem and
then clear does not have any affect.

Example :


 TLptsDBStatementCriteriaItemType spit = new TLptsDBStatementCriteriaItemType();
 if(spit.getPrimaryColumnListItemSize() > 0)
   spit.clearPrimaryColumnListItem();

 


clearStaticStringListItem

public void clearStaticStringListItem()

Clear the staticStringListItem list.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : n/a

Notes : * Notes : Use this to clear the list. Getting the list with getStaticStringListItem and
then clear does not have any affect.

Example :


 TLptsDBStatementCriteriaItemType spit = new TLptsDBStatementCriteriaItemType();
 if(spit.getStaticStringListItemSize() > 0)
   spit.clearStaticStringListItem();

 


equals

public boolean equals(java.lang.Object obj)

Check for equal TLptsDBStatementCriteriaItemType objects.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : n/a

Notes : Use this to compare two TLptsDBStatementCriteriaItemType objects by there id's.

Example :


 TLptsDBStatementCriteriaItemType spit1 = new TLptsDBStatementCriteriaItemType();
 TLptsDBStatementCriteriaItemType spit2 = new TLptsDBStatementCriteriaItemType();
 return spit1.equals(spit2);

 

Overrides:
equals in class java.lang.Object
Parameters:
obj - the statement parameter item type.
Returns:
true if they are equal, else false.

getJoinOnListItem

public java.util.List<XLptsDBStatementJoinType> getJoinOnListItem()

Returns a copy of the actual list.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : Never. The result may be an empty list.

Notes : Do not add to this list as there is no result. Use the addJoinOnListItem function.

Example :


 TLptsDBStatementCriteriaItemType spit =  new TLptsDBStatementCriteriaItemType();
 TLptsDBStatementColumnType column = new TLptsDBStatementColumnType();
 for(XLptsDBStatementJoinType spjot : spit.getJoinOnListItem())
   if(spjot.getFromColumn().equals(column))
     break;

 

Overrides:
getJoinOnListItem in class XLptsDBStatementCriteriaItemType
Returns:
Returns a list of join list items.

getJoinOnListItemSize

public int getJoinOnListItemSize()

Returns the size of the actual list.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : Never. The result may be an empty list.

Notes : Do not use getJoinOnListItem().size() as it is not efficient.

Example :


 TLptsDBStatementCriteriaItemType spit =  new TLptsDBStatementCriteriaItemType();
 if(spit.getJoinOnListItemSize() > 0)
   return true;
 else
   return false;

 

Returns:
Returns the number of connections.

getJoinUsingColumnListItem

public java.util.List<XLptsDBStatementColumnType> getJoinUsingColumnListItem()

Returns a copy of the join USING column list.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : Never. The result may be an empty list.

Notes :
This list contains the column information for the join USING columns.

Example :

 

Overrides:
getJoinUsingColumnListItem in class XLptsDBStatementCriteriaItemType
Returns:
Returns a list of columns of this parameter.

getJoinUsingColumnListItem

public XLptsDBStatementColumnType getJoinUsingColumnListItem(int index)

Returns .

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : Never. The result may be an empty list.

Notes : Use this function to get a column selected by index and not getJoinUsingColumnListItem().get(index).

Example :

 

Parameters:
index - is the index of the column
Returns:
Returns XLptsDBStatementColumnType by index.

getJoinUsingColumnListItemSize

public int getJoinUsingColumnListItemSize()

Returns the size of the actual list.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : Never. The result may be an empty list.

Notes : Do not use getJoinUsingColumnListItem().size() as it is not efficient.

Example :


 TLptsDBStatementCriteriaItemType spit = new TLptsDBStatementCriteriaItemType();
 if(spit.getJoinUsingColumnListItemSize() > 0)
   return true;
 else
   return false;

 

Returns:
Returns the number of connections.

getPrimaryColumnListItem

public java.util.List<XLptsDBStatementColumnType> getPrimaryColumnListItem()

Returns a copy of the primary column list.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : Never. The result may be an empty list.

Notes :
This list contains the column information for the primary columns that feed data to this statement at the index(s)
specified in addPrimaryIndexListItem(Integer). This is Normally done through TLptsStatement.addPrimaryRelationship(int, int[], java.lang.String).
Note: Do not add to this list as there is no result. Use the addPrimaryColumnListItem function.
If there is more than one item in this list then the operation TLptsDBStatementCriteriaItemType is either IN or BETWEEN.

Example :


 TLptsDBStatementCriteriaItemType spit =  new TLptsDBStatementCriteriaItemType();
 String columnName = "id";
 for(XLptsDBStatementColumnType column : spit.getPrimaryColumnListItem())
   if(column.toString().equals(columnName))
     break;

 

Overrides:
getPrimaryColumnListItem in class XLptsDBStatementCriteriaItemType
Returns:
Returns a list of columns of this parameter.

getPrimaryColumnListItem

public XLptsDBStatementColumnType getPrimaryColumnListItem(int index)

Returns .

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : Never. The result may be an empty list.

Notes : Use this function to get a column selected by index and not getPrimaryColumnListItem().get(index).

Example :


 public TLptsDBStatementColumnType example(int index)
 {
   TLptsDBStatementCriteriaItemType spit = new TLptsDBStatementCriteriaItemType();
   return spit.getPrimaryColumnListItem(index);
 }

 

Parameters:
index - is the index of the column
Returns:
Returns XLptsDBStatementColumnType by index.

getPrimaryColumnListItemSize

public int getPrimaryColumnListItemSize()

Returns the size of the actual list.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : Never. The result may be an empty list.

Notes : This function outperforms getPrimaryColumnListItem().size().

Example :


 TLptsDBStatementCriteriaItemType spit = new TLptsDBStatementCriteriaItemType();
 if(spit.getPrimaryColumnListItemSize() > 0)
   return true;
 else
   return false;

 

Returns:
Returns the number of connections.

getPrimaryIndexListItem

public java.util.List<java.lang.Integer> getPrimaryIndexListItem()

Returns a copy of the actual list.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : Never. The result may be an empty list.

Notes : Do not add to this list as there is no result. Use the addPrimaryIndexListItem function.

Example :


 TLptsDBStatementCriteriaItemType spit =  new TLptsDBStatementCriteriaItemType();
 int primary = 2;
 for(int pr_index : spit.getPrimaryIndexListItem())
   if(primary == pr_index)
     break;

 

Overrides:
getPrimaryIndexListItem in class XLptsDBStatementCriteriaItemType
Returns:
Returns a list of primary index list items.

getPrimaryIndexListItemSize

public int getPrimaryIndexListItemSize()

Returns the size of the actual list.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : Never. The result may be an empty list.

Notes : Do not use getPrimaryIndexListItem().size() as it is not efficient.

Example :


 TLptsDBStatementCriteriaItemType spit =  new TLptsDBStatementCriteriaItemType();
 if(spit.getPrimaryIndexListItemSize() > 0)
   return true;
 else
   return false;

 

Returns:
Returns the number of connections.

getStaticStringListItem

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

Returns a copy of the actual list.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : Never. The result may be an empty list.

Notes : Do not add to this list as there is no result. Use the addStaticStringListItem function.

Example :


 TLptsDBStatementCriteriaItemType spit =  new TLptsDBStatementCriteriaItemType();
 String static = "static name";
 for(String st : spit.getStaticStringListItem())
   if(st.equals(static))
     break;

 

Overrides:
getStaticStringListItem in class XLptsDBStatementCriteriaItemType
Returns:
Returns a list of static string list items.

getStaticStringListItemSize

public int getStaticStringListItemSize()

Returns the size of the actual list.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : Never. The result may be an empty list.

Notes : Do not use getStaticStringListItem().size() as it is not efficient.

Example :


 TLptsDBStatementCriteriaItemType spit =  new TLptsDBStatementCriteriaItemType();
 if(spit.getStaticStringListItemSize() > 0)
   return true;
 else
   return false;

 

Returns:
Returns the number of connections.

removeJoinOnListItem

public void removeJoinOnListItem(int index)

Removes the join item from the joinOnListItem list by index.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : n/a

Notes : Use this to remove from the list. Getting the list with getJoinOnListItem and
then removing does not have any affect.

Example :


 public void example(int index)
 {
   TLptsDBStatementCriteriaItemType spit =  new TLptsDBStatementCriteriaItemType();
   spit.removeJoinOnListItem(index);
 }

 

Parameters:
index - the index of the join item to remove from list.

removeJoinOnListItem

public void removeJoinOnListItem(XLptsDBStatementJoinType item)

Removes the join item from the joinOnListItem list.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : n/a

Notes : Use this to remove from the list. Getting the list with getJoinOnListItem and
then removing does not have any affect.

Example :


 TLptsDBStatementCriteriaItemType spit =  new TLptsDBStatementCriteriaItemType();
 TLptsDBStatementColumnType column = new TLptsDBStatementColumnType();
 for(XLptsDBStatementJoinType spjot : spit.getJoinOnListItem())
   if(spjot.getFromColumn().equals(column))
   {
     spit.removeJoinOnListItem(spjot);
     break;
   }

 

Parameters:
item - the join item to remove from list.

removeJoinUsingColumnListItem

public void removeJoinUsingColumnListItem(int index)

Removes the column from the criteria column list by index.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : n/a

Notes : Use this to remove from the list. Getting the list with getJoinUsingColumnListItem and
then removing does not have any affect.

Example :


 

Parameters:
index - the index of the column to remove from list.

removeJoinUsingColumnListItem

public void removeJoinUsingColumnListItem(XLptsDBStatementColumnType item)

Removes the column from the criteria column list.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : n/a

Notes : Use this to remove from the list. Getting the list with getJoinUsingColumnListItem and
then removing does not have any affect.

Example :


 TLptsDBStatementCriteriaItemType spit =  new TLptsDBStatementCriteriaItemType();
 String columnName = "id";
 for(XLptsDBStatementColumnType column : spit.getJoinUsingColumnListItem())
   if(column.toString().equals(columnName))
   {
     spit.removeJoinUsingColumnListItem(column);
     break;
   }

 

Parameters:
item - the column to remove from list.

removePrimaryColumnListItem

public void removePrimaryColumnListItem(int index)

Removes the column from the criteria column list by index.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : n/a

Notes : Use this to remove from the list. Getting the list with getPrimaryColumnListItem and
then removing does not have any affect.

Example :


 public void example(int index)
 {
   TLptsDBStatementCriteriaItemType spit =  new TLptsDBStatementCriteriaItemType();
   spit.removePrimaryColumnListItem(index);
 }

 

Parameters:
index - the index of the column to remove from list.

removePrimaryColumnListItem

public void removePrimaryColumnListItem(XLptsDBStatementColumnType item)

Removes the column from the criteria column list.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : n/a

Notes : Use this to remove from the list. Getting the list with getPrimaryColumnListItem and
then removing does not have any affect.

Example :


 TLptsDBStatementCriteriaItemType spit =  new TLptsDBStatementCriteriaItemType();
 String columnName = "id";
 for(XLptsDBStatementColumnType column : spit.getPrimaryColumnListItem())
   if(column.toString().equals(columnName))
   {
     spit.removePrimaryColumnListItem(column);
     break;
   }

 

Parameters:
item - the column to remove from list.

removePrimaryIndexListItem

public void removePrimaryIndexListItem(java.lang.Integer item)

Removes the primary index item from the primaryIndexListItem list.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : n/a

Notes : Use this to remove from the list. Getting the list with getPrimaryIndexListItem and
then removing does not have any affect.

Example :


 TLptsDBStatementCriteriaItemType spit =  new TLptsDBStatementCriteriaItemType();
 int primary = 3;
 for(int prim_index : spit.getPrimaryIndexListItem())
   if(primary == prim_index)
   {
     spit.removePrimaryIndexListItem(primary);
     break;
   }

 

Parameters:
item - the join item to remove from list.

removePrimaryIndexListItemByIndex

public void removePrimaryIndexListItemByIndex(int index)

Removes the primary index item from the primaryIndexListItem list by index.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : n/a

Notes : Use this to remove from the list. Getting the list with getPrimaryIndexListItem and
then removing does not have any affect.

Example :


 public void example(int index)
 {
   TLptsDBStatementCriteriaItemType spit =  new TLptsDBStatementCriteriaItemType();
   spit.removePrimaryIndexListItemByIndex(index);
 }

 

Parameters:
index - the index of the primary index to remove from list.

removeStaticStringListItem

public void removeStaticStringListItem(int index)

Removes the static item from the staticStringListItem list by index.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : n/a

Notes : Use this to remove from the list. Getting the list with getStaticStringListItem and
then removing does not have any affect.

Example :


 public void example(int index)
 {
   TLptsDBStatementCriteriaItemType spit =  new TLptsDBStatementCriteriaItemType();
   spit.removeStaticStringListItem(index);
 }

 

Parameters:
index - the index of the static string to remove from list.

removeStaticStringListItem

public void removeStaticStringListItem(java.lang.String item)

Removes the String item from the staticStringListItem list.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : n/a

Notes : Use this to remove from the list. Getting the list with getStaticStringListItem and
then removing does not have any affect.

Example :


 TLptsDBStatementCriteriaItemType spit =  new TLptsDBStatementCriteriaItemType();
 String static = "static name";
 for(String st : spit.getStaticStringListItem())
   if(st.equals(static))
   {
     spit.removeStaticStringListItem(static);
     break;
   }

 

Parameters:
item - the join item to remove from list.


Copyright 2009,2010, Lapetus Systems Ltd. (All rights reserved)