com.buildforge.services.common.dbo
Class GeoDBO

java.lang.Object
  extended by com.buildforge.services.common.dbo.DBObject
      extended by com.buildforge.services.common.dbo.GeoAwareDBObject
          extended by com.buildforge.services.common.dbo.GeoDBO

public class GeoDBO
extends GeoAwareDBObject

Database information representing a geographic database location.


Field Summary
static java.lang.String TYPE_KEY
           
 
Constructor Summary
GeoDBO()
           
 
Method Summary
 GeoDBO fromArray(java.lang.Object[] data)
          Deserialize the database object's settings from a request array.
 boolean getActive()
           
 java.lang.String getDatabaseName()
           
 java.lang.String getDatabaseType()
           
 java.lang.String getFailover()
           
 java.lang.String getHostname()
           
 java.lang.String getLocation()
           
 java.lang.String getPassword()
           
 java.lang.String getPort()
           
 java.lang.String getTypeKey()
          Retrieve the key that should be used to look up the display name for a data type.
 java.lang.String getUsername()
           
 boolean isLive()
          Checks whether or not the object is live.
 void setActive(boolean newActive)
           
 void setDatabaseName(java.lang.String newDatabaseName)
           
 void setDatabaseType(java.lang.String newDatabaseType)
           
 void setFailover(java.lang.String newFailover)
           
 void setHostname(java.lang.String newHostname)
           
 void setLocation(java.lang.String newLocation)
           
 void setPassword(java.lang.String newPassword)
           
 void setPort(java.lang.String newPort)
           
 void setUsername(java.lang.String newUsername)
           
 java.lang.Object[] toArray()
          Serializes this database object as an array of objects.
 java.lang.String toString()
           
 
Methods inherited from class com.buildforge.services.common.dbo.GeoAwareDBObject
getGeoId, setGeoId
 
Methods inherited from class com.buildforge.services.common.dbo.DBObject
badId, badName, checkDead, checkLive, collision, collision
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TYPE_KEY

public static final java.lang.String TYPE_KEY
See Also:
Constant Field Values
Constructor Detail

GeoDBO

public GeoDBO()
Method Detail

getTypeKey

public java.lang.String getTypeKey()
Description copied from class: DBObject
Retrieve the key that should be used to look up the display name for a data type.

Specified by:
getTypeKey in class DBObject
Returns:
the type key for this object's class

isLive

public boolean isLive()
Description copied from class: DBObject
Checks whether or not the object is live. Note that this is not valid for object types that do not have a unique identifier. Those for which no reasonable implementation exists should always return false.

Specified by:
isLive in class DBObject
Returns:
true iff liveness is a valid concept for this object, and the object is live; otherwise, false is returned.

getActive

public boolean getActive()

getDatabaseName

public java.lang.String getDatabaseName()

getDatabaseType

public java.lang.String getDatabaseType()

getFailover

public java.lang.String getFailover()

getHostname

public java.lang.String getHostname()

getLocation

public java.lang.String getLocation()

getPassword

public java.lang.String getPassword()

getPort

public java.lang.String getPort()

getUsername

public java.lang.String getUsername()

setActive

public void setActive(boolean newActive)

setDatabaseName

public void setDatabaseName(java.lang.String newDatabaseName)

setDatabaseType

public void setDatabaseType(java.lang.String newDatabaseType)

setFailover

public void setFailover(java.lang.String newFailover)

setHostname

public void setHostname(java.lang.String newHostname)

setLocation

public void setLocation(java.lang.String newLocation)

setPassword

public void setPassword(java.lang.String newPassword)

setPort

public void setPort(java.lang.String newPort)

setUsername

public void setUsername(java.lang.String newUsername)

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

toArray

public java.lang.Object[] toArray()
Description copied from class: DBObject
Serializes this database object as an array of objects. As specified in the description for Protocol, all supported protocols transfer database objects in this form.

Specified by:
toArray in class DBObject

fromArray

public GeoDBO fromArray(java.lang.Object[] data)
                 throws APIException
Description copied from class: DBObject
Deserialize the database object's settings from a request array. This method is used to reconstruct a database object from the array that was created by DBObject.toArray().

Specified by:
fromArray in class DBObject
Parameters:
data - the object list that renders this object
Returns:
this object, for convenience
Throws:
APIException - if there is something wrong with the serialized data that interferes with the reconstruction of the object. The most obvious reason for this would be if the serialized array contains the wrong number of fields or otherwise does not match the serialized form for this type of database object.