OSGi 8.1.0 · org.osgi.service.dmt.MetaNode · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
public static final int	AUTOMATIC Constant for representing an automatic node in the tree.
public static final int	CMD_ADD Constant for the ADD access type.
public static final int	CMD_DELETE Constant for the DELETE access type.
public static final int	CMD_EXECUTE Constant for the EXECUTE access type.
public static final int	CMD_GET Constant for the GET access type.
public static final int	CMD_REPLACE Constant for the REPLACE access type.
public static final int	DYNAMIC Constant for representing a dynamic node in the tree.
public static final int	PERMANENT Constant for representing a `PERMANENT` node in the tree.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `false` if the operation is not valid for this node or the operation code is not one of the allowed constants can(int One of the `MetaNode.CMD_...` constants. operation) Check whether the given operation is valid for this node.
public DmtData	Returns: The default value or `null` if not defined getDefault() Get the default value of this node if any.
public String	Returns: node description string or `null` for no description getDescription() Get the explanation string associated with this node.
public Object	Returns: the value of the requested property, cannot be `null` getExtensionProperty(String the key for the extension property key) Returns the value for the specified extension property key.
public String[]	Returns: the array of supported extension property keys getExtensionPropertyKeys() Returns the list of extension property keys, if the provider of this `MetaNode` provides proprietary extensions to node meta data.
public int	Returns: the allowed format(s) of the node getFormat() Get the node's format, expressed in terms of type constants defined in `DmtData`.
public double	Returns: the allowed maximum, or `Double.MAX_VALUE` if there is no upper limit defined or the node's format is not one of the numeric formats integer, float, or long getMax() Get the maximum allowed value associated with a node of numeric format.
public int	Returns: The maximum allowed occurrence of this node type getMaxOccurrence() Get the number of maximum occurrences of this type of nodes on the same level in the DMT.
public String[]	Returns: the list of allowed MIME types for this node, starting with the default MIME type, or `null` if all types are allowed getMimeTypes() Get the list of MIME types this node can hold.
public double	Returns: the allowed minimum, or `Double.MIN_VALUE` if there is no lower limit defined or the node's format is not one of the numeric formats integer, float, or long getMin() Get the minimum allowed value associated with a node of numeric format.
public String[]	Returns: the allowed format name(s) of raw data stored by the node, or `null` if raw formats are not supported getRawFormatNames() Get the format names for any raw formats supported by the node.
public int	Returns: `PERMANENT` for permanent nodes, `AUTOMATIC` for nodes that are automatically created, and `DYNAMIC` otherwise getScope() Return the scope of the node.
public String[]	Returns: the valid values for this node name, or `null` if not defined getValidNames() Return an array of Strings if valid names are defined for the node, or `null` if no valid name list is defined or if this piece of meta info is not supported.
public DmtData[]	Returns: the valid values for this node, or `null` if not defined getValidValues() Return an array of DmtData objects if valid values are defined for the node, or `null` otherwise.
public boolean	Returns: `true` if the node is a leaf node isLeaf() Check whether the node is a leaf node or an internal one.
public boolean	Returns: `false` if the specified name is found to be invalid for the node described by this meta-node, `true` otherwise isValidName(String the node name to check for validity name) Checks whether the given name is a valid name for this node.
public boolean	Returns: `false` if the specified value is found to be invalid for the node described by this meta-node, `true` otherwise isValidValue(DmtData the value to check for validity value) Checks whether the given value is valid for this node.
public boolean	Returns: `true` if zero occurrence of this node is valid isZeroOccurrenceAllowed() Check whether zero occurrence of this node is valid.

Field Detail

AUTOMATIC	back to summary
public static final int AUTOMATIC Constant for representing an automatic node in the tree. This must be returned by `getScope()`. `AUTOMATIC` nodes are part of the life cycle of their parent node, they usually describe attributes/properties of the parent.

CMD_ADD	back to summary
public static final int CMD_ADD Constant for the ADD access type. If `can(int)` returns `true` for this operation, this node can potentially be added to its parent. Nodes with `PERMANENT` or `AUTOMATIC` scope typically do not have this access type.

CMD_DELETE	back to summary
public static final int CMD_DELETE Constant for the DELETE access type. If `can(int)` returns `true` for this operation, the node can potentially be deleted.

CMD_EXECUTE	back to summary
public static final int CMD_EXECUTE Constant for the EXECUTE access type. If `can(int)` returns `true` for this operation, the node can potentially be executed.

CMD_GET	back to summary
public static final int CMD_GET Constant for the GET access type. If `can(int)` returns `true` for this operation, the value, the list of child nodes (in case of interior nodes) and the properties of the node can potentially be retrieved.

CMD_REPLACE	back to summary
public static final int CMD_REPLACE Constant for the REPLACE access type. If `can(int)` returns `true` for this operation, the value and other properties of the node can potentially be modified.

DYNAMIC	back to summary
public static final int DYNAMIC Constant for representing a dynamic node in the tree. This must be returned by `getScope()`. Dynamic nodes can be added and deleted.

PERMANENT	back to summary
public static final int PERMANENT Constant for representing a `PERMANENT` node in the tree. This must be returned by `getScope()` if the node cannot be added, deleted or modified in any way through tree operations. `PERMANENT` nodes in general map to the roots of Plugins.

Method Detail

can back to summary

can	back to summary
public boolean can(int operation) Check whether the given operation is valid for this node. If no meta-data is provided for a node, all operations are valid. Parameters operation:int One of the `MetaNode.CMD_...` constants. Returns:boolean `false` if the operation is not valid for this node or the operation code is not one of the allowed constants

public boolean can(int operation)

Check whether the given operation is valid for this node. If no meta-data is provided for a node, all operations are valid.

Parameters

operation:int: One of the MetaNode.CMD_... constants.

Returns:boolean

false if the operation is not valid for this node or the operation code is not one of the allowed constants

getDefault back to summary

getDefault	back to summary
public DmtData getDefault() Get the default value of this node if any. Returns:DmtData The default value or `null` if not defined

public DmtData getDefault()

Get the default value of this node if any.

Returns:DmtData: The default value or null if not defined

getDescription back to summary

getDescription	back to summary
public String getDescription() Get the explanation string associated with this node. Can be `null` if no description is provided for this node. Returns:String node description string or `null` for no description

public String getDescription()

Get the explanation string associated with this node. Can be null if no description is provided for this node.

Returns:String: node description string or null for no description

getExtensionProperty back to summary

getExtensionProperty	back to summary
public Object getExtensionProperty(String key) Returns the value for the specified extension property key. This method only works if the provider of this `MetaNode` provides proprietary extensions to node meta data. Parameters key:String the key for the extension property Returns:Object the value of the requested property, cannot be `null` Exceptions IllegalArgumentException: if the specified key is not supported by this `MetaNode`

public Object getExtensionProperty(String key)

Returns the value for the specified extension property key. This method only works if the provider of this MetaNode provides proprietary extensions to node meta data.

Parameters

key:String: the key for the extension property

Returns:Object

the value of the requested property, cannot be null

Exceptions

IllegalArgumentException:: if the specified key is not supported by this MetaNode

getExtensionPropertyKeys back to summary

getExtensionPropertyKeys	back to summary
public String[] getExtensionPropertyKeys() Returns the list of extension property keys, if the provider of this `MetaNode` provides proprietary extensions to node meta data. The method returns `null` if the node doesn't provide such extensions. Returns:String[] the array of supported extension property keys

public String[] getExtensionPropertyKeys()

Returns the list of extension property keys, if the provider of this MetaNode provides proprietary extensions to node meta data. The method returns null if the node doesn't provide such extensions.

Returns:String[]: the array of supported extension property keys

getFormat back to summary

getFormat	back to summary
public int getFormat() Get the node's format, expressed in terms of type constants defined in `DmtData`. If there are multiple formats allowed for the node then the format constants are OR-ed. Interior nodes must have `DmtData#FORMAT_NODE` format, and this code must not be returned for leaf nodes. If no meta-data is provided for a node, all applicable formats are considered valid (with the above constraints regarding interior and leaf nodes). Note that the 'format' term is a legacy from OMA DM, it is more customary to think of this as 'type'. The formats returned by this method are not checked by DmtAdmin, they are only for external use, for example in user interfaces. DmtAdmin only calls `isValidValue(DmtData)` for checking the value, its behavior should be consistent with this method. Returns:int the allowed format(s) of the node

public int getFormat()

Get the node's format, expressed in terms of type constants defined in DmtData. If there are multiple formats allowed for the node then the format constants are OR-ed. Interior nodes must have DmtData#FORMAT_NODE format, and this code must not be returned for leaf nodes. If no meta-data is provided for a node, all applicable formats are considered valid (with the above constraints regarding interior and leaf nodes).

Note that the 'format' term is a legacy from OMA DM, it is more customary to think of this as 'type'.

The formats returned by this method are not checked by DmtAdmin, they are only for external use, for example in user interfaces. DmtAdmin only calls isValidValue(DmtData) for checking the value, its behavior should be consistent with this method.

Returns:int: the allowed format(s) of the node

getMax back to summary

getMax	back to summary
public double getMax() Get the maximum allowed value associated with a node of numeric format. If no meta-data is provided for a node, there is no upper limit to its value. This method is only meaningful if the node has one of the numeric formats: integer, float, or long format. The returned limit has `double` type, as this can be used to denote all numeric limits with full precision. The actual maximum should be the largest integer, float or long number that does not exceed the returned value. The information returned by this method is not checked by DmtAdmin, it is only for external use, for example in user interfaces. DmtAdmin only calls `isValidValue(DmtData)` for checking the value, its behavior should be consistent with this method. Returns:double the allowed maximum, or `Double.MAX_VALUE` if there is no upper limit defined or the node's format is not one of the numeric formats integer, float, or long

public double getMax()

Get the maximum allowed value associated with a node of numeric format. If no meta-data is provided for a node, there is no upper limit to its value. This method is only meaningful if the node has one of the numeric formats: integer, float, or long format. The returned limit has double type, as this can be used to denote all numeric limits with full precision. The actual maximum should be the largest integer, float or long number that does not exceed the returned value.

The information returned by this method is not checked by DmtAdmin, it is only for external use, for example in user interfaces. DmtAdmin only calls isValidValue(DmtData) for checking the value, its behavior should be consistent with this method.

Returns:double: the allowed maximum, or Double.MAX_VALUE if there is no upper limit defined or the node's format is not one of the numeric formats integer, float, or long

getMaxOccurrence back to summary

getMaxOccurrence	back to summary
public int getMaxOccurrence() Get the number of maximum occurrences of this type of nodes on the same level in the DMT. Returns `Integer.MAX_VALUE` if there is no upper limit. Note that if the occurrence is greater than 1 then this node can not have siblings with different metadata. In other words, if different types of nodes coexist on the same level, their occurrence can not be greater than 1. If no meta-data is provided for a node, there is no upper limit on the number of occurrences. Returns:int The maximum allowed occurrence of this node type

public int getMaxOccurrence()

Get the number of maximum occurrences of this type of nodes on the same level in the DMT. Returns Integer.MAX_VALUE if there is no upper limit. Note that if the occurrence is greater than 1 then this node can not have siblings with different metadata. In other words, if different types of nodes coexist on the same level, their occurrence can not be greater than 1. If no meta-data is provided for a node, there is no upper limit on the number of occurrences.

Returns:int: The maximum allowed occurrence of this node type

getMimeTypes back to summary

getMimeTypes	back to summary
public String[] getMimeTypes() Get the list of MIME types this node can hold. The first element of the returned list must be the default MIME type. All MIME types are considered valid if no meta-data is provided for a node or if `null` is returned by this method. In this case the default MIME type cannot be retrieved from the meta-data, but the node may still have a default. This hidden default (if it exists) can be utilized by passing `null` as the type parameter of `DmtSession#setNodeType(String, String)` or `DmtSession#createLeafNode(String, DmtData, String)`. Returns:String[] the list of allowed MIME types for this node, starting with the default MIME type, or `null` if all types are allowed

public String[] getMimeTypes()

Get the list of MIME types this node can hold. The first element of the returned list must be the default MIME type.

All MIME types are considered valid if no meta-data is provided for a node or if null is returned by this method. In this case the default MIME type cannot be retrieved from the meta-data, but the node may still have a default. This hidden default (if it exists) can be utilized by passing null as the type parameter of DmtSession#setNodeType(String, String) or DmtSession#createLeafNode(String, DmtData, String).

Returns:String[]: the list of allowed MIME types for this node, starting with the default MIME type, or null if all types are allowed

getMin back to summary

getMin	back to summary
public double getMin() Get the minimum allowed value associated with a node of numeric format. If no meta-data is provided for a node, there is no lower limit to its value. This method is only meaningful if the node has one of the numeric formats: integer, float, or long format. The returned limit has `double` type, as this can be used to denote both integer and float limits with full precision. The actual minimum should be the smallest integer, float or long value that is equal or larger than the returned value. The information returned by this method is not checked by DmtAdmin, it is only for external use, for example in user interfaces. DmtAdmin only calls `isValidValue(DmtData)` for checking the value, its behavior should be consistent with this method. Returns:double the allowed minimum, or `Double.MIN_VALUE` if there is no lower limit defined or the node's format is not one of the numeric formats integer, float, or long

public double getMin()

Get the minimum allowed value associated with a node of numeric format. If no meta-data is provided for a node, there is no lower limit to its value. This method is only meaningful if the node has one of the numeric formats: integer, float, or long format. The returned limit has double type, as this can be used to denote both integer and float limits with full precision. The actual minimum should be the smallest integer, float or long value that is equal or larger than the returned value.

Returns:double: the allowed minimum, or Double.MIN_VALUE if there is no lower limit defined or the node's format is not one of the numeric formats integer, float, or long

getRawFormatNames back to summary

getRawFormatNames	back to summary
public String[] getRawFormatNames() Get the format names for any raw formats supported by the node. This method is only meaningful if the list of supported formats returned by `getFormat()` contains `DmtData#FORMAT_RAW_STRING` or `DmtData#FORMAT_RAW_BINARY`: it specifies precisely which raw format(s) are actually supported. If the node cannot contain data in one of the raw types, this method must return `null`. The format names returned by this method are not checked by DmtAdmin, they are only for external use, for example in user interfaces. DmtAdmin only calls `isValidValue(DmtData)` for checking the value, its behavior should be consistent with this method. Returns:String[] the allowed format name(s) of raw data stored by the node, or `null` if raw formats are not supported

public String[] getRawFormatNames()

Get the format names for any raw formats supported by the node. This method is only meaningful if the list of supported formats returned by getFormat() contains DmtData#FORMAT_RAW_STRING or DmtData#FORMAT_RAW_BINARY: it specifies precisely which raw format(s) are actually supported. If the node cannot contain data in one of the raw types, this method must return null.

The format names returned by this method are not checked by DmtAdmin, they are only for external use, for example in user interfaces. DmtAdmin only calls isValidValue(DmtData) for checking the value, its behavior should be consistent with this method.

Returns:String[]: the allowed format name(s) of raw data stored by the node, or null if raw formats are not supported

getScope back to summary

getScope	back to summary
public int getScope() Return the scope of the node. Valid values are `MetaNode.PERMANENT`, `MetaNode.DYNAMIC` and `MetaNode.AUTOMATIC`. Note that a permanent node is not the same as a node where the DELETE operation is not allowed. Permanent nodes never can be deleted, whereas a non-deletable node can disappear in a recursive DELETE operation issued on one of its parents. If no meta-data is provided for a node, it can be assumed to be a dynamic node. Returns:int `PERMANENT` for permanent nodes, `AUTOMATIC` for nodes that are automatically created, and `DYNAMIC` otherwise

public int getScope()

Return the scope of the node. Valid values are MetaNode.PERMANENT, MetaNode.DYNAMIC and MetaNode.AUTOMATIC. Note that a permanent node is not the same as a node where the DELETE operation is not allowed. Permanent nodes never can be deleted, whereas a non-deletable node can disappear in a recursive DELETE operation issued on one of its parents. If no meta-data is provided for a node, it can be assumed to be a dynamic node.

Returns:int: PERMANENT for permanent nodes, AUTOMATIC for nodes that are automatically created, and DYNAMIC otherwise

getValidNames back to summary

getValidNames	back to summary
public String[] getValidNames() Return an array of Strings if valid names are defined for the node, or `null` if no valid name list is defined or if this piece of meta info is not supported. If no meta-data is provided for a node, all names are considered valid. The information returned by this method is not checked by DmtAdmin, it is only for external use, for example in user interfaces. DmtAdmin only calls `isValidName(String)` for checking the name, its behavior should be consistent with this method. Returns:String[] the valid values for this node name, or `null` if not defined

public String[] getValidNames()

Return an array of Strings if valid names are defined for the node, or null if no valid name list is defined or if this piece of meta info is not supported. If no meta-data is provided for a node, all names are considered valid.

The information returned by this method is not checked by DmtAdmin, it is only for external use, for example in user interfaces. DmtAdmin only calls isValidName(String) for checking the name, its behavior should be consistent with this method.

Returns:String[]: the valid values for this node name, or null if not defined

getValidValues back to summary

getValidValues	back to summary
public DmtData[] getValidValues() Return an array of DmtData objects if valid values are defined for the node, or `null` otherwise. If no meta-data is provided for a node, all values are considered valid. The information returned by this method is not checked by DmtAdmin, it is only for external use, for example in user interfaces. DmtAdmin only calls `isValidValue(DmtData)` for checking the value, its behavior should be consistent with this method. Returns:DmtData[] the valid values for this node, or `null` if not defined

public DmtData[] getValidValues()

Return an array of DmtData objects if valid values are defined for the node, or null otherwise. If no meta-data is provided for a node, all values are considered valid.

Returns:DmtData[]: the valid values for this node, or null if not defined

isLeaf back to summary

isLeaf	back to summary
public boolean isLeaf() Check whether the node is a leaf node or an internal one. Returns:boolean `true` if the node is a leaf node

public boolean isLeaf()

Check whether the node is a leaf node or an internal one.

Returns:boolean: true if the node is a leaf node

isValidName back to summary

isValidName	back to summary
public boolean isValidName(String name) Checks whether the given name is a valid name for this node. This method can be used for example to ensure that the node name is always one of a predefined set of valid names, or that it matches a specific pattern. This method should be consistent with the values returned by `getValidNames()` (if any), the DmtAdmin only calls this method for name validation. This method may return `true` even if not all aspects of the name have been checked, expensive operations (for example those that require external resources) need not be performed here. The actual node creation may still indicate that the node name is invalid. Parameters name:String the node name to check for validity Returns:boolean `false` if the specified name is found to be invalid for the node described by this meta-node, `true` otherwise

public boolean isValidName(String name)

Checks whether the given name is a valid name for this node. This method can be used for example to ensure that the node name is always one of a predefined set of valid names, or that it matches a specific pattern. This method should be consistent with the values returned by getValidNames() (if any), the DmtAdmin only calls this method for name validation.

This method may return true even if not all aspects of the name have been checked, expensive operations (for example those that require external resources) need not be performed here. The actual node creation may still indicate that the node name is invalid.

Parameters

name:String: the node name to check for validity

Returns:boolean

false if the specified name is found to be invalid for the node described by this meta-node, true otherwise

isValidValue back to summary

isValidValue	back to summary
public boolean isValidValue(DmtData value) Checks whether the given value is valid for this node. This method can be used to ensure that the value has the correct format and range, that it is well formed, etc. This method should be consistent with the constraints defined by the `getFormat()`, `getValidValues()`, `getMin()` and `getMax()` methods (if applicable), as the Dmt Admin only calls this method for value validation. This method may return `true` even if not all aspects of the value have been checked, expensive operations (for example those that require external resources) need not be performed here. The actual value setting method may still indicate that the value is invalid. Parameters value:DmtData the value to check for validity Returns:boolean `false` if the specified value is found to be invalid for the node described by this meta-node, `true` otherwise

public boolean isValidValue(DmtData value)

Checks whether the given value is valid for this node. This method can be used to ensure that the value has the correct format and range, that it is well formed, etc. This method should be consistent with the constraints defined by the getFormat(), getValidValues(), getMin() and getMax() methods (if applicable), as the Dmt Admin only calls this method for value validation.

This method may return true even if not all aspects of the value have been checked, expensive operations (for example those that require external resources) need not be performed here. The actual value setting method may still indicate that the value is invalid.

Parameters

value:DmtData: the value to check for validity

Returns:boolean

false if the specified value is found to be invalid for the node described by this meta-node, true otherwise

isZeroOccurrenceAllowed back to summary

isZeroOccurrenceAllowed	back to summary
public boolean isZeroOccurrenceAllowed() Check whether zero occurrence of this node is valid. If no meta-data is returned for a node, zero occurrences are allowed. Returns:boolean `true` if zero occurrence of this node is valid

public boolean isZeroOccurrenceAllowed()

Check whether zero occurrence of this node is valid. If no meta-data is returned for a node, zero occurrences are allowed.

Returns:boolean: true if zero occurrence of this node is valid

public Interface MetaNode

Field Summary

Method Summary

Field Detail

Method Detail