com.buildforge.services.common.dbo
Class CollectorPropertyDBO
java.lang.Object
com.buildforge.services.common.dbo.DBObject
com.buildforge.services.common.dbo.CollectorPropertyDBO
public class CollectorPropertyDBO
- extends DBObject
Database information representing a single property definition for a
collector.
Constructor Summary |
CollectorPropertyDBO()
|
CollectorPropertyDBO(java.lang.String collectorId,
java.lang.String newPropertyName,
java.lang.String newPropertyValue,
boolean newUserDefined,
java.lang.String newRegEx,
boolean newDirty,
int newSequence)
|
Methods inherited from class java.lang.Object |
getClass, hashCode, notify, notifyAll, wait, wait, wait |
TYPE_KEY
public static final java.lang.String TYPE_KEY
- See Also:
- Constant Field Values
CLASS
public static final java.lang.Class<CollectorPropertyDBO> CLASS
CollectorPropertyDBO
public CollectorPropertyDBO()
CollectorPropertyDBO
public CollectorPropertyDBO(java.lang.String collectorId,
java.lang.String newPropertyName,
java.lang.String newPropertyValue,
boolean newUserDefined,
java.lang.String newRegEx,
boolean newDirty,
int newSequence)
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.
getCollectorId
public java.lang.String getCollectorId()
getPropertyName
public java.lang.String getPropertyName()
getPropertyValue
public java.lang.String getPropertyValue()
getLiveSequenceNumber
public int getLiveSequenceNumber()
getRegex
public java.lang.String getRegex()
getUserDefined
public boolean getUserDefined()
getDirty
public boolean getDirty()
getSequenceNumber
public int getSequenceNumber()
setCollectorId
public void setCollectorId(java.lang.String collectorId)
setPropertyName
public void setPropertyName(java.lang.String propertyName)
setPropertyValue
public void setPropertyValue(java.lang.String propertyValue)
setLiveSequenceNumber
public void setLiveSequenceNumber(int newLive)
setRegex
public void setRegex(java.lang.String regex)
setUserDefined
public void setUserDefined(boolean userDefined)
setDirty
public void setDirty(boolean dirty)
setSequenceNumber
public void setSequenceNumber(int newSequence)
fromArray
public CollectorPropertyDBO 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.
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
sanityCheck
public static void sanityCheck(java.lang.String thisCollectorId)
throws APIException
- Throws:
APIException
sanityCheck
public static void sanityCheck(int thisSequenceId)
throws APIException
- Throws:
APIException
equals
public boolean equals(java.lang.Object other)
- Overrides:
equals
in class java.lang.Object
toString
public java.lang.String toString()
- Overrides:
toString
in class java.lang.Object
clone
public CollectorPropertyDBO clone()
- Overrides:
clone
in class java.lang.Object