public interface Remapper
Modifier and Type | Method and Description |
---|---|
boolean |
addNode(java.lang.String nodeId,
java.lang.String nodeClass,
java.lang.String[] names,
java.lang.Object[] values)
Add new node of specified class with specified ID.
|
boolean |
addNodeBitField(java.lang.String nodeId,
java.lang.String name,
BitField value)
Add new
BitField value to the attribute. |
boolean |
addNodeBitSelector(java.lang.String nodeId,
java.lang.String name,
BitSelector value)
Add new
BitSelector value to the attribute. |
boolean |
addNodeBoolean(java.lang.String nodeId,
java.lang.String name,
boolean value)
Add new
boolean value to the attribute. |
boolean |
addNodeByteArray(java.lang.String nodeId,
java.lang.String name,
byte[] value)
Add new
byte array value to the attribute. |
boolean |
addNodeDate(java.lang.String nodeId,
java.lang.String name,
DateValue value)
Add new
DateValue value to the attribute. |
boolean |
addNodeDouble(java.lang.String nodeId,
java.lang.String name,
double value)
Add new
double value to the attribute. |
boolean |
addNodeInteger(java.lang.String nodeId,
java.lang.String name,
int value)
Add new
int value to the attribute. |
boolean |
addNodeString(java.lang.String nodeId,
java.lang.String name,
java.lang.String value)
Add new
String value to the attribute. |
boolean |
addNodeTime(java.lang.String nodeId,
java.lang.String name,
TimeValue value)
Add new
TimeValue value to the attribute. |
boolean |
bind()
Initialise back-end and open session.
|
boolean |
deleteNode(java.lang.String nodeId)
Remove specified node from the directory (unless node has children).
|
boolean |
deleteNodeAttribute(java.lang.String nodeId,
java.lang.String name)
Remove whole node attribute.
|
boolean |
deleteNodeAttributeValue(java.lang.String nodeId,
java.lang.String name,
int index)
Remove particular value from the node attribute.
|
AttributeDefinition[] |
enumerateNodeAttributes(java.lang.String nodeId)
Return list of all node attribute definitions.
|
java.lang.String[] |
enumerateNodes(java.lang.String nodeId)
Get direct list of children nodes for current node.
|
AttributeDefinition[] |
getClassDefinition(java.lang.String className)
Get definitions for all class attributes.
|
java.lang.String[] |
getClassNames()
Get list of names of all defined classes.
|
BitField |
getNodeBitField(java.lang.String nodeId,
java.lang.String name,
int index)
Get
BitField attribute value for specified node ID and
index. |
BitSelector |
getNodeBitSelector(java.lang.String nodeId,
java.lang.String name,
int index)
Get
BitSelector attribute value for specified node ID and
index. |
java.lang.Boolean |
getNodeBoolean(java.lang.String nodeId,
java.lang.String name,
int index)
Get
Boolean attribute value for specified node ID and
index. |
byte[] |
getNodeByteArray(java.lang.String nodeId,
java.lang.String name,
int index)
Get
byte array attribute value for specified node ID and
index. |
java.lang.String |
getNodeClassName(java.lang.String nodeId)
Return class name for the specified node.
|
DateValue |
getNodeDate(java.lang.String nodeId,
java.lang.String name,
int index)
Get
DateValue attribute value for specified node ID and
index. |
java.lang.Double |
getNodeDouble(java.lang.String nodeId,
java.lang.String name,
int index)
Get
Double attribute value for specified node ID and
index. |
java.lang.Integer |
getNodeInteger(java.lang.String nodeId,
java.lang.String name,
int index)
Get
Integer attribute value for specified node ID and
index. |
java.lang.String |
getNodeString(java.lang.String nodeId,
java.lang.String name,
int index)
Get
String attribute value for specified node ID and
index. |
TimeValue |
getNodeTime(java.lang.String nodeId,
java.lang.String name,
int index)
Get
TimeValue attribute value for specified node ID and
index. |
boolean |
isClassImmutable(java.lang.String className)
Class is immutable if the back-end does not allow any change to its
state.
|
boolean |
isClassLeaf(java.lang.String className)
Class is leaf if no other object can be created under objects of the
class.
|
boolean |
moveNode(java.lang.String nodeId,
java.lang.String newId)
Moves or renames the existing object, specified by nodeId to different
location.
|
boolean |
refresh()
Reload directory content from external source.
|
boolean |
setNodeBitField(java.lang.String nodeId,
java.lang.String name,
int index,
BitField value)
Set
BitField attribute value for specified node ID,
attribute name and index. |
boolean |
setNodeBitSelector(java.lang.String nodeId,
java.lang.String name,
int index,
BitSelector value)
Set
BitSelector attribute value for specified node ID,
attribute name and index. |
boolean |
setNodeBoolean(java.lang.String nodeId,
java.lang.String name,
int index,
boolean value)
Set
boolean attribute value for specified node ID,
attribute name and index. |
boolean |
setNodeByteArray(java.lang.String nodeId,
java.lang.String name,
int index,
byte[] value)
Set
byte array attribute value for specified node ID,
attribute name and index. |
boolean |
setNodeDate(java.lang.String nodeId,
java.lang.String name,
int index,
DateValue value)
Set
DateValue attribute value for specified node ID,
attribute name and index. |
boolean |
setNodeDouble(java.lang.String nodeId,
java.lang.String name,
int index,
double value)
Set
double attribute value for specified node ID,
attribute name and index. |
boolean |
setNodeInteger(java.lang.String nodeId,
java.lang.String name,
int index,
int value)
Set
int attribute value for specified node ID, attribute
name and index. |
boolean |
setNodeString(java.lang.String nodeId,
java.lang.String name,
int index,
java.lang.String value)
Set
String attribute value for specified node ID,
attribute name and index. |
boolean |
setNodeTime(java.lang.String nodeId,
java.lang.String name,
int index,
TimeValue value)
Set
TimeValue attribute value for specified node ID,
attribute name and index. |
boolean |
unbind()
Close session and shutdown back-end.
|
boolean |
update()
Update external storage.
|
java.lang.String getNodeClassName(java.lang.String nodeId)
nodeId
- Node for which class name is requested.boolean addNode(java.lang.String nodeId, java.lang.String nodeClass, java.lang.String[] names, java.lang.Object[] values)
nodeId
- Node name.nodeClass
- Node class name.names
- A list of names of the attributes.values
- A list of values of the attributes.true
if operation was successful and
false
otherwise.boolean addNodeBitField(java.lang.String nodeId, java.lang.String name, BitField value)
BitField
value to the attribute.nodeId
- Node identifier.name
- Attribute name.value
- New value for the attribute variable.true
is operation is successful and
false
otherwise.boolean addNodeBitSelector(java.lang.String nodeId, java.lang.String name, BitSelector value)
BitSelector
value to the attribute.nodeId
- Node identifier.name
- Attribute name.value
- New value for the attribute variable.true
is operation is successful and
false
otherwise.boolean addNodeBoolean(java.lang.String nodeId, java.lang.String name, boolean value)
boolean
value to the attribute.nodeId
- Node identifier.name
- Attribute name.value
- New value for the attribute variable.true
is operation is successful and
false
otherwise.boolean addNodeByteArray(java.lang.String nodeId, java.lang.String name, byte[] value)
byte array
value to the attribute.nodeId
- Node identifier.name
- Attribute name.value
- New value for the attribute variable.true
is operation is successful and
false
otherwise.boolean addNodeDate(java.lang.String nodeId, java.lang.String name, DateValue value)
DateValue
value to the attribute.nodeId
- Node identifier.name
- Attribute name.value
- New value for the attribute variable.true
is operation is successful and
false
otherwise.boolean addNodeDouble(java.lang.String nodeId, java.lang.String name, double value)
double
value to the attribute.nodeId
- Node identifier.name
- Attribute name.value
- New value for the attribute variable.true
is operation is successful and
false
otherwise.boolean addNodeInteger(java.lang.String nodeId, java.lang.String name, int value)
int
value to the attribute.nodeId
- Node identifier.name
- Attribute name.value
- New value for the attribute variable.true
is operation is successful and
false
otherwise.boolean addNodeString(java.lang.String nodeId, java.lang.String name, java.lang.String value)
String
value to the attribute.nodeId
- Node identifier.name
- Attribute name.value
- New value for the attribute variable.true
is operation is successful and
false
otherwise.boolean addNodeTime(java.lang.String nodeId, java.lang.String name, TimeValue value)
TimeValue
value to the attribute.nodeId
- Node identifier.name
- Attribute name.value
- New value for the attribute variable.true
is operation is successful and
false
otherwise.boolean deleteNode(java.lang.String nodeId)
nodeId
- Node identifier.true
if operation was successful and
false
otherwise.boolean deleteNodeAttribute(java.lang.String nodeId, java.lang.String name)
nodeId
- Node name.name
- Attribute name.true
if operation was successful and
false
otherwise.boolean deleteNodeAttributeValue(java.lang.String nodeId, java.lang.String name, int index)
nodeId
- Node name.name
- Attribute name.index
- Attribute value index.true
if operation was successful and
false
otherwise.AttributeDefinition[] enumerateNodeAttributes(java.lang.String nodeId)
nodeId
- Node for which list of attributes is requested.java.lang.String[] enumerateNodes(java.lang.String nodeId)
nodeId
- Node for which list of nodes is requested.AttributeDefinition[] getClassDefinition(java.lang.String className)
className
- Name of the class.java.lang.String[] getClassNames()
BitField getNodeBitField(java.lang.String nodeId, java.lang.String name, int index)
BitField
attribute value for specified node ID and
index. If wrong parameter (node ID, attribute name or index) are passed
or attribute type is not BitField
then null
is returned.nodeId
- Node identifier.name
- Attribute name.index
- Index of the value to retrieve.BitSelector getNodeBitSelector(java.lang.String nodeId, java.lang.String name, int index)
BitSelector
attribute value for specified node ID and
index. If wrong parameter (node ID, attribute name or index) are passed
or attribute type is not BitSelector
then
null
is returned.nodeId
- Node identifier.name
- Attribute name.index
- Index of the value to retrieve.java.lang.Boolean getNodeBoolean(java.lang.String nodeId, java.lang.String name, int index)
Boolean
attribute value for specified node ID and
index. If wrong parameter (node ID, attribute name or index) are passed
or attribute type is not Boolean
then null
is returned.nodeId
- Node identifier.name
- Attribute name.index
- Index of the value to retrieve.byte[] getNodeByteArray(java.lang.String nodeId, java.lang.String name, int index)
byte array
attribute value for specified node ID and
index. If wrong parameter (node ID, attribute name or index) are passed
or attribute type is not byte array
then
null
is returned.nodeId
- Node identifier.name
- Attribute name.index
- Index of the value to retrieve.DateValue getNodeDate(java.lang.String nodeId, java.lang.String name, int index)
DateValue
attribute value for specified node ID and
index. If wrong parameter (node ID, attribute name or index) are passed
or attribute type is not DateValue
then null
is returned.nodeId
- Node identifier.name
- Attribute name.index
- Index of the value to retrieve.java.lang.Double getNodeDouble(java.lang.String nodeId, java.lang.String name, int index)
Double
attribute value for specified node ID and
index. If wrong parameter (node ID, attribute name or index) are passed
or attribute type is not Double
then null
is returned.nodeId
- Node identifier.name
- Attribute name.index
- Index of the value to retrieve.java.lang.Integer getNodeInteger(java.lang.String nodeId, java.lang.String name, int index)
Integer
attribute value for specified node ID and
index. If wrong parameter (node ID, attribute name or index) are passed
or attribute type is not Integer
then null
is returned.nodeId
- Node identifier.name
- Attribute name.index
- Index of the value to retrieve.java.lang.String getNodeString(java.lang.String nodeId, java.lang.String name, int index)
String
attribute value for specified node ID and
index. If wrong parameter (node ID, attribute name or index) are passed
or attribute type is not String
then null
is returned.nodeId
- Node identifier.name
- Attribute name.index
- Index of the value to retrieve.TimeValue getNodeTime(java.lang.String nodeId, java.lang.String name, int index)
TimeValue
attribute value for specified node ID and
index. If wrong parameter (node ID, attribute name or index) are passed
or attribute type is not TimeValue
then null
is returned.nodeId
- Node identifier.name
- Attribute name.index
- Index of the value to retrieve.boolean isClassImmutable(java.lang.String className)
className
- Name of the class.true
if class is read-only.boolean isClassLeaf(java.lang.String className)
className
- Name of the class.true
if class is leaf.boolean moveNode(java.lang.String nodeId, java.lang.String newId)
nodeId
- An ID of the node to move.newId
- The desired new location of the node.true
is operation is successful and
false
otherwise.boolean setNodeBitField(java.lang.String nodeId, java.lang.String name, int index, BitField value)
BitField
attribute value for specified node ID,
attribute name and index. If wrong parameter is passed or attribute
read-only then false
is returned.nodeId
- Node identifier.name
- Attribute name.index
- Index of the value to retrieve.value
- New value for the attribute variable.true
is operation is successful and
false
otherwise.boolean setNodeBitSelector(java.lang.String nodeId, java.lang.String name, int index, BitSelector value)
BitSelector
attribute value for specified node ID,
attribute name and index. If wrong parameter is passed or attribute
read-only then false
is returned.nodeId
- Node identifier.name
- Attribute name.index
- Index of the value to retrieve.value
- New value for the attribute variable.true
is operation is successful and
false
otherwise.boolean setNodeBoolean(java.lang.String nodeId, java.lang.String name, int index, boolean value)
boolean
attribute value for specified node ID,
attribute name and index. If wrong parameter is passed or attribute
read-only then false
is returned.nodeId
- Node identifier.name
- Attribute name.index
- Index of the value to retrieve.value
- New value for the attribute variable.true
is operation is successful and
false
otherwise.boolean setNodeByteArray(java.lang.String nodeId, java.lang.String name, int index, byte[] value)
byte array
attribute value for specified node ID,
attribute name and index. If wrong parameter is passed or attribute
read-only then false
is returned.nodeId
- Node identifier.name
- Attribute name.index
- Index of the value to retrieve.value
- New value for the attribute variable.true
is operation is successful and
false
otherwise.boolean setNodeDate(java.lang.String nodeId, java.lang.String name, int index, DateValue value)
DateValue
attribute value for specified node ID,
attribute name and index. If wrong parameter is passed or attribute
read-only then false
is returned.nodeId
- Node identifier.name
- Attribute name.index
- Index of the value to retrieve.value
- New value for the attribute variable.true
is operation is successful and
false
otherwise.boolean setNodeDouble(java.lang.String nodeId, java.lang.String name, int index, double value)
double
attribute value for specified node ID,
attribute name and index. If wrong parameter is passed or attribute
read-only then false
is returned.nodeId
- Node identifier.name
- Attribute name.index
- Index of the value to retrieve.value
- New value for the attribute variable.true
is operation is successful and
false
otherwise.boolean setNodeInteger(java.lang.String nodeId, java.lang.String name, int index, int value)
int
attribute value for specified node ID, attribute
name and index. If wrong parameter is passed or attribute read-only then
false
is returned.nodeId
- Node identifier.name
- Attribute name.index
- Index of the value to retrieve.value
- New value for the attribute variable.true
is operation is successful and
false
otherwise.boolean setNodeString(java.lang.String nodeId, java.lang.String name, int index, java.lang.String value)
String
attribute value for specified node ID,
attribute name and index. If wrong parameter is passed or attribute
read-only then false
is returned.nodeId
- Node identifier.name
- Attribute name.index
- Index of the value to retrieve.value
- New value for the attribute variable.true
is operation is successful and
false
otherwise.boolean setNodeTime(java.lang.String nodeId, java.lang.String name, int index, TimeValue value)
TimeValue
attribute value for specified node ID,
attribute name and index. If wrong parameter is passed or attribute
read-only then false
is returned.nodeId
- Node identifier.name
- Attribute name.index
- Index of the value to retrieve.value
- New value for the attribute variable.true
is operation is successful and
false
otherwise.boolean bind()
true
if operation was successful.boolean unbind()
true
if operation was successful.boolean update()
true
if operation was successful.boolean refresh()
Note that it is backend responsibility to preserve its state when refresh operation was not successful.
true
if operation was successful.