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

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

java.lang.Object
  extended by com.lapetus_ltd._2009.xml.types.XLptsDriverExtensionType
      extended by com.lapetus_ltd.api.db.xml.types.TLptsDriverExtensionType

public class TLptsDriverExtensionType
extends XLptsDriverExtensionType

Class Description : This class is the main class for the ODBC driver capability.

It holds a list of operating systems TLptsODBCDriverType, which have driver items declared in them.
The driver items are of type TLptsDriverExtensionSubType.

$LastChangedRevision: 1190 $
$LastChangedDate:: 2010-11-17 13:21:35#$


Field Summary
 
Fields inherited from class com.lapetus_ltd._2009.xml.types.XLptsDriverExtensionType
id, operatingSystemListItem, version
 
Constructor Summary
TLptsDriverExtensionType()
           This constructor initiates the id, version and operating system list.
TLptsDriverExtensionType(XLptsDriverExtensionType det)
           This constructor copies the driver extension information from an XLptsDriverExtensionType.
 
Method Summary
 void addOperatingSystemListItem(XLptsODBCDriverType opt)
           Adds the operating system odbc information to the driver extension list.
 boolean equals(java.lang.Object obj)
           Check for equal TLptsDriverExtensionType objects.
 java.util.List<XLptsODBCDriverType> getOperatingSystemListItem()
           Returns a copy of the actual list.
 int getOperatingSystemListItemSize()
           Returns the size of the actual list.
 void removeOperatingSystemListItem(XLptsODBCDriverType opt)
           Removes the operating system odbc information from the driver extension list.
 
Methods inherited from class com.lapetus_ltd._2009.xml.types.XLptsDriverExtensionType
getId, getVersion, setId, setVersion
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TLptsDriverExtensionType

public TLptsDriverExtensionType()

This constructor initiates the id, version and operating system list.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : Never.

Notes : Default Constructor set id, version to "1.2.0" and initialize operating system list.

Example :

 public void saveDriverExtensionType
 {
    TLptsDriverExtensionType det = new TLptsDriverExtensionType();
    XLptsODBCDriverType sdt = new XLptsODBCDriverType();
    XLptsDriverExtensionSubType dest = new XLptsDriverExtensionSubType();
 

sdt.setOsName("Windows Vista"); det.setId(TLptsXmlUtil.getIdentifier()); det.setVersion("1.2.0"); ... dest.setDriverName("Microsoft Access Driver (*.mdb, *.accdb)"); dest.setExtension("mdb"); sdt.getDriverListItem().add(dest); ... det.addOperatingSystemListItem(sdt); ... ObjectFactory of = new ObjectFactory(); //Save driver extension type to a file TLptsXmlUtil.marshal("driver.xml", XLptsDriverExtensionType.class,of.createXLptsDriverExtensionType(det)); }


TLptsDriverExtensionType

public TLptsDriverExtensionType(XLptsDriverExtensionType det)

This constructor copies the driver extension information from an XLptsDriverExtensionType.

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 XLptsDriverExtensionType class.

Example :

 public void saveDriverExtensionType
 {
    TLptsDriverExtensionType det = new TLptsDriverExtensionType();
    XLptsODBCDriverType sdt = new XLptsODBCDriverType();
    XLptsDriverExtensionSubType dest = new XLptsDriverExtensionSubType();
 

sdt.setOsName("Windows Vista"); det.setId(TLptsXmlUtil.getIdentifier()); det.setVersion("1.2.0"); ... dest.setDriverName("Microsoft Access Driver (*.mdb, *.accdb)"); dest.setExtension("mdb"); sdt.getDriverListItem().add(dest); ... det.addOperatingSystemListItem(sdt); ... ObjectFactory of = new ObjectFactory(); //Save driver extension type to a file TLptsXmlUtil.marshal("driver.xml", XLptsDriverExtensionType.class,of.createXLptsDriverExtensionType(det)); }

Parameters:
det - the class object to copy. This is normally taken from the driver extension xml file.
Method Detail

addOperatingSystemListItem

public void addOperatingSystemListItem(XLptsODBCDriverType opt)

Adds the operating system odbc information to the driver extension 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 getOperatingSystemListItem and
then adding does not have any affect.

Example :

 public void saveDriverExtensionType
 {
    TLptsDriverExtensionType det = new TLptsDriverExtensionType();
    XLptsODBCDriverType sdt = new XLptsODBCDriverType();
    XLptsDriverExtensionSubType dest = new XLptsDriverExtensionSubType();
 

sdt.setOsName("Windows Vista"); det.setId(TLptsXmlUtil.getIdentifier()); det.setVersion("1.2.0"); ... dest.setDriverName("Microsoft Access Driver (*.mdb, *.accdb)"); dest.setExtension("mdb"); sdt.getDriverListItem().add(dest); ... det.addOperatingSystemListItem(sdt); ... ObjectFactory of = new ObjectFactory(); //Save driver extension type to a file TLptsXmlUtil.marshal("driver.xml", XLptsDriverExtensionType.class,of.createXLptsDriverExtensionType(det)); }

Parameters:
opt -

equals

public boolean equals(java.lang.Object obj)

Check for equal TLptsDriverExtensionType objects.

Thread Safe : Yes

Spawns its own Thread : No

May Return NULL : n/a

Notes : Use this to compare two TLptsDriverExtensionType objects by there id.

Example :

 

TLptsDriverExtensionType det1 = new TLptsDriverExtensionType(); TLptsDriverExtensionType det2 = new TLptsDriverExtensionType(); return det1.equals(det2);

Result: false, because each TLptsDriverExtensionType has his own unique id.

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

getOperatingSystemListItem

public java.util.List<XLptsODBCDriverType> getOperatingSystemListItem()

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 addOperatingSystemListItem function.

Example :

 

XLptsDriverExtensionType xdet = (XLptsDriverExtensionType) TLptsXmlUtil.unmarshal(selectedFile,XLptsDriverExtensionType.class); TLptsDriverExtensionType det = new TLptsDriverExtensionType(xdet); if(det.getOperatingSystemListItemSize==0) TLptsLogger.logMessage("Operateing ",null) for(XLptsODBCDriverType dt = det.getOperatingSystemListItem()) if(dt.getOsName.equals("Windows Vista")) { det.removeOperatingSystemListItem(dt); }

Overrides:
getOperatingSystemListItem in class XLptsDriverExtensionType
Returns:
Returns a list of the Windows operating systems with their ODBC extension/driver information.

getOperatingSystemListItemSize

public int getOperatingSystemListItemSize()

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 getOperatingSystemListItem().size() as it is not efficient.

Example :

 

XLptsDriverExtensionType xdet = (XLptsDriverExtensionType) TLptsXmlUtil.unmarshal(selectedFile,XLptsDriverExtensionType.class); TLptsDriverExtensionType det = new TLptsDriverExtensionType(xdet); if(det.getOperatingSystemListItemSize==0) TLptsLogger.logMessage("Operateing ",null) for(XLptsODBCDriverType dt = det.getOperatingSystemListItem()) if(dt.getOsName.equals("Windows Vista")) { det.removeOperatingSystemListItem(dt); }

Returns:
Returns the number of connections.

removeOperatingSystemListItem

public void removeOperatingSystemListItem(XLptsODBCDriverType opt)

Removes the operating system odbc information from the driver extension 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 getOperatingSystemListItem and
then removing does not have any affect.

Example :

 

XLptsDriverExtensionType xdet = (XLptsDriverExtensionType) TLptsXmlUtil.unmarshal(selectedFile,XLptsDriverExtensionType.class); TLptsDriverExtensionType det = new TLptsDriverExtensionType(xdet); if(det.getOperatingSystemListItemSize==0) TLptsLogger.logMessage("Operateing ",null) for(XLptsODBCDriverType dt = det.getOperatingSystemListItem()) if(dt.getOsName.equals("Windows Vista")) { det.removeOperatingSystemListItem(dt); }

Parameters:
opt -


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