|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.util.Observable org.fosstrak.llrp.commander.util.LLRPTreeMaintainer
public class LLRPTreeMaintainer
This class constitutes the interface to llrp message objects.
All modifications to llrp message objects are performed through this class.
Users of this class can register to be notified when changes to the llrp message occur.
This class has a reference to the LLRPMessage
object and is not implemented
as a static class, because the implementation of the getParent(...)
method
requires to know the root of the object tree.
Constructor Summary | |
---|---|
LLRPTreeMaintainer(org.llrp.ltk.types.LLRPMessage root)
|
Method Summary | |
---|---|
void |
addChild(java.util.List<org.llrp.ltk.types.LLRPParameter> list,
org.llrp.ltk.types.LLRPParameter child)
Adds the given parameter to the given parameter list. |
java.lang.Object |
getChild(java.lang.Object messageOrParameter,
java.lang.String childName)
Returns the child with the given name of the given message/parameter. |
java.lang.Object |
getDefinition(java.lang.Object messageOrParameter)
Returns the definition of the given message or parameter. |
org.llrp.ltk.types.LLRPType |
getField(java.lang.Object messageOrParameter,
java.lang.String fieldName)
Returns the field with the given name of the given message/parameter |
java.util.List<org.llrp.ltk.types.LLRPType> |
getFields(java.lang.Object messageOrParameter)
Returns all fields of the given message/parameter. |
java.lang.String |
getName(java.lang.Object treeElement)
Returns the name of the given tree element. |
java.util.List<java.lang.Object> |
getNonNullChildren(java.lang.Object treeElement)
Returns all children of the given tree element that are not null. |
java.util.List<java.lang.Object> |
getNonRecursivelyInvalidMessageOrParameterDescendants(java.lang.Object treeElement)
Returns all message/parameter descendants of the given tree element which are (non-recursively) invalid (including the tree element itself). |
java.lang.Object |
getParent(java.lang.Object treeElement)
Returns the parent of the given tree element. |
org.llrp.ltk.types.LLRPMessage |
getRoot()
Returns the llrp message associated with this LLRPTreeMaintainer . |
boolean |
isNonRecursivelyValid(java.lang.Object treeElement)
Returns true if the given tree element is valid (ignoring the validity of its descendants),
and false otherwise. |
boolean |
isValid(java.lang.Object treeElement)
Returns true if the given tree element is valid (including all its descendants), and false otherwise. |
void |
removeChild(java.util.List<org.llrp.ltk.types.LLRPParameter> list,
org.llrp.ltk.types.LLRPParameter child)
Removes the given parameter from the given parameter list. |
void |
setChild(java.lang.Object messageOrParameter,
java.lang.String childName,
org.llrp.ltk.types.LLRPParameter child)
Sets the given parameter as child of the given message/parameter. |
void |
setField(java.lang.Object messageOrParameter,
java.lang.String fieldName,
org.llrp.ltk.types.LLRPType fieldValue)
Sets the field with the given name of the given message/parameter to the given value. |
void |
setRoot(org.llrp.ltk.types.LLRPMessage root)
Sets the llrp message this LLRPTreeMaintainer shall maintain. |
java.lang.String |
validateChildPresence(java.lang.Object messageOrParameter,
java.lang.String childName)
Checks whether the child is present when it has to be present. |
java.lang.String |
validateEmptiness(java.util.List<org.llrp.ltk.types.LLRPParameter> list)
Checks whether the list is non-empty when it has to be non-empty. |
java.lang.String |
validateField(java.lang.Object messageOrParameter,
java.lang.String fieldName)
Checks whether the field with the given name of the given message/parameter is valid. |
Methods inherited from class java.util.Observable |
---|
addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LLRPTreeMaintainer(org.llrp.ltk.types.LLRPMessage root)
Method Detail |
---|
public void setRoot(org.llrp.ltk.types.LLRPMessage root)
LLRPTreeMaintainer
shall maintain.
root
- the llrp message LLRPTreeMaintainer
shall maintainpublic org.llrp.ltk.types.LLRPMessage getRoot()
LLRPTreeMaintainer
.
LLRPTreeMaintainer
.public void setChild(java.lang.Object messageOrParameter, java.lang.String childName, org.llrp.ltk.types.LLRPParameter child)
messageOrParameter
- either a LLRPMessage
or a LLRPParameter
childName
- the name of the childchild
- the parameter that should be set as a childpublic void addChild(java.util.List<org.llrp.ltk.types.LLRPParameter> list, org.llrp.ltk.types.LLRPParameter child)
list
- the parameter list to which the child shall be addedchild
- the parameter to add to the parameter listpublic void removeChild(java.util.List<org.llrp.ltk.types.LLRPParameter> list, org.llrp.ltk.types.LLRPParameter child)
list
- the parameter list from which the child shall be removedchild
- thepublic java.lang.Object getChild(java.lang.Object messageOrParameter, java.lang.String childName)
messageOrParameter
- either a LLRPMessage
or a LLRPParameter
childName
- the name of the child.
public java.util.List<java.lang.Object> getNonNullChildren(java.lang.Object treeElement)
treeElement
- either a LLRPMessage
or a LLRPParameter
or a List<LLRPParameter>
public java.lang.Object getParent(java.lang.Object treeElement)
Null
is returned.
This implementation searches the whole message object tree
for the given tree element (starting at the root). This is
done, because LTKJava does not provide references from children
to their parents (i.e. from sub-parameters to parameters).
treeElement
- either a LLRPMessage
or a LLRPParameter
or a List<LLRPParameter>
public org.llrp.ltk.types.LLRPType getField(java.lang.Object messageOrParameter, java.lang.String fieldName)
messageOrParameter
- either a LLRPMessage
or a LLRPParameter
fieldName
-
public void setField(java.lang.Object messageOrParameter, java.lang.String fieldName, org.llrp.ltk.types.LLRPType fieldValue)
messageOrParameter
- either a LLRPMessage
or a LLRPParameter
fieldName
- fieldValue
- public java.util.List<org.llrp.ltk.types.LLRPType> getFields(java.lang.Object messageOrParameter)
messageOrParameter
- either a LLRPMessage
or a LLRPParameter
public boolean isValid(java.lang.Object treeElement)
true
if the given tree element is valid (including all its descendants), and false
otherwise.
treeElement
- either a LLRPMessage
or a LLRPParameter
or a List<LLRPParameter>
public boolean isNonRecursivelyValid(java.lang.Object treeElement)
true
if the given tree element is valid (ignoring the validity of its descendants),
and false
otherwise.
treeElement
- either a LLRPMessage
or a LLRPParameter
or a List<LLRPParameter>
public java.util.List<java.lang.Object> getNonRecursivelyInvalidMessageOrParameterDescendants(java.lang.Object treeElement)
treeElement
- either a LLRPMessage
or a LLRPParameter
or a List<LLRPParameter>
LLRPMessage
s and LLRPParameter
spublic java.lang.String validateField(java.lang.Object messageOrParameter, java.lang.String fieldName)
messageOrParameter
- either a LLRPMessage
or a LLRPParameter
fieldName
-
public java.lang.String validateChildPresence(java.lang.Object messageOrParameter, java.lang.String childName)
messageOrParameter
- either a LLRPMessage
or a LLRPParameter
childName
-
public java.lang.String validateEmptiness(java.util.List<org.llrp.ltk.types.LLRPParameter> list)
list
-
public java.lang.String getName(java.lang.Object treeElement)
treeElement
- either a LLRPMessage
or a LLRPParameter
or a List<LLRPParameter>
public java.lang.Object getDefinition(java.lang.Object messageOrParameter)
messageOrParameter
- either a LLRPMessage
or a LLRPParameter
MessageDefinition
or a ParameterDefinition
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |