|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.buildforge.services.common.dbo.DBObject
com.buildforge.services.common.dbo.CollectorDBO
public class CollectorDBO
Database information representing a collector.
Field Summary | |
---|---|
static java.lang.Class<CollectorDBO> |
CLASS
|
static java.lang.String |
TYPE_KEY
|
Constructor Summary | |
---|---|
CollectorDBO()
|
Method Summary | |
---|---|
void |
addCollectorProperty(CollectorPropertyDBO prop)
Adds the supplied CollectorProperty to the end of the property list |
CollectorPropertyDBO |
addCollectorProperty(CollectorPropertyDBO prop,
int index)
Adds the supplied collector property DBO at the specified index, shifting the property at the index (and all subsequent properties) by one position to make room for it. |
CollectorDBO |
clone()
|
CollectorPropertyDBO |
copyCollectorProperty(int index)
Returns a copy of the specified collector property DBO. |
CollectorPropertyDBO |
copyCollectorProperty(int fromIndex,
int toIndex,
boolean live)
Copies the specified property into a new position in the property list. |
CollectorDBO |
fromArray(java.lang.Object[] data)
Deserialize the database object's settings from a request array. |
java.lang.String |
getCollectorId()
|
java.util.List<CollectorPropertyDBO> |
getCollectorProperties()
|
CollectorPropertyDBO |
getCollectorProperty(int index)
|
CollectorPropertyDBO |
getCollectorProperty(java.lang.String propertyName)
Retrieves the first collector property DBO with the specified name that is currently in the property list. |
java.lang.String |
getLiveCollectorId()
|
int |
getSize()
|
java.lang.String |
getTypeKey()
Retrieve the key that should be used to look up the display name for a data type. |
boolean |
isLive()
Checks whether or not the object is live. |
void |
moveCollectorProperty(int fromIndex,
int toIndex)
Moves a property from one index to another. |
CollectorPropertyDBO |
removeCollectorProperty(int index)
Removes a collector property DBO by index. |
void |
setCollectorId(java.lang.String collectorId)
|
void |
setLiveCollectorId(java.lang.String newLiveCollectorId)
Sets this live ID for this collector DBO, updating its own state and those of its properties accordingly. |
void |
setProperties(java.util.List<CollectorPropertyDBO> newProperties)
|
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.DBObject |
---|
badId, badName, checkDead, checkLive, collision, collision |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String TYPE_KEY
public static final java.lang.Class<CollectorDBO> CLASS
Constructor Detail |
---|
public CollectorDBO()
Method Detail |
---|
public java.lang.String getTypeKey()
DBObject
getTypeKey
in class DBObject
public boolean isLive()
DBObject
isLive
in class DBObject
public java.lang.String getCollectorId()
public java.lang.String getLiveCollectorId()
public java.util.List<CollectorPropertyDBO> getCollectorProperties()
public int getSize()
public CollectorPropertyDBO getCollectorProperty(int index)
public void setLiveCollectorId(java.lang.String newLiveCollectorId)
newLiveCollectorId
- the ID to set as livepublic void setCollectorId(java.lang.String collectorId)
public void setProperties(java.util.List<CollectorPropertyDBO> newProperties)
public void addCollectorProperty(CollectorPropertyDBO prop)
prop
- public CollectorPropertyDBO addCollectorProperty(CollectorPropertyDBO prop, int index) throws APIException
prop
- the collector property DBO to insertindex
- the 0-based index at which to insert the new
property. If this value would place the new property beyond the
end of the list, then it is placed at the end.
APIException
public CollectorPropertyDBO getCollectorProperty(java.lang.String propertyName)
propertyName
- the property name to find
public CollectorPropertyDBO removeCollectorProperty(int index) throws APIException
index
- the 0-basex index of the collector property DBO
to remove from the list
APIException
public void moveCollectorProperty(int fromIndex, int toIndex) throws APIException
fromIndex
- the 0-based original index of the propertytoIndex
- the 0-based index of the property after it has
been moved. If the value would move the property past the end
of the property list, then it is moved to the end.
APIException
public CollectorPropertyDBO copyCollectorProperty(int index) throws APIException
index
- the 0-based index to specify the property to copy
APIException
public CollectorPropertyDBO copyCollectorProperty(int fromIndex, int toIndex, boolean live) throws APIException
fromIndex
- the 0-based index of the property that
from which the values for the new property will be copiedtoIndex
- the 0-based index at which to insert the
new property. If this value is larger than the current size
of the list, then the new property is placed at the end of
the list.
APIException
public java.lang.String toString()
toString
in class java.lang.Object
public CollectorDBO clone()
clone
in class java.lang.Object
public CollectorDBO fromArray(java.lang.Object[] data) throws APIException
DBObject
DBObject.toArray()
.
fromArray
in class DBObject
data
- the object list that renders this object
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.public java.lang.Object[] toArray()
DBObject
Protocol
, all supported
protocols transfer database objects in this form.
toArray
in class DBObject
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |