|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.omg.PortableServer.Servant
org.omg.CosPropertyService.PropertySetPOA
org.openorb.property.PropertySetImpl
public class PropertySetImpl
PropertySetImpl
is an implementation of the
org.omg.CosPropertyService.PropertySet
interface.
The PropertySet
interface provides operations to define
and modify properties, list and get properties, and delete properties.
The PropertySet
interface also provides "batch" operations,
such as define_properties
, to deal with sets of properties
as a whole. The execution of the "batch" operations is considered best
effort (i.e., not an atomic set) in that not all suboperations need
succeed for any suboperation to succeed.
For define_properties
and delete_properties
,
if any suboperation fails, a MultipleExceptions
exception
is returned to identify which property name had which exception.
For example, a client may invoke define_properties
using
three property structures. The first property could be accepted (added
or modified), the second could fail due to an InvalidPropertyName
,
and the third could fail due to a ConflictingProperty
. In
this case a property is either added or modified in the PropertySet
,
and a MultipleExceptions
is raised with two items in the
PropertyExceptions
sequence.
The get_properties
and delete_all_properties
"batch" operations utilize a boolean
flag to identify that
mixed results occurred and additional processing may be required to fully
analyze the exceptions.
Making "batch" operations behave in an atomic manner is considered an implementation issue that could be accomplished via specialization of this property service.
Constructor Summary | |
---|---|
PropertySetImpl(org.omg.CORBA.ORB orb)
Creates a new (empty) instance of PropertySetImpl . |
|
PropertySetImpl(org.omg.CORBA.ORB orb,
Property[] initial_properties)
Creates a new instance of PropertySetImpl with
the specified initial properties. |
|
PropertySetImpl(org.omg.CORBA.ORB orb,
org.omg.CORBA.TypeCode[] allowed_property_types,
Property[] allowed_properties)
Creates a new instance of PropertySetImpl with
the specified constraints. |
Method Summary | |
---|---|
void |
define_properties(Property[] nproperties)
Modifies or adds each of the properties in Properties
parameter to the PropertySet . |
void |
define_property(java.lang.String property_name,
org.omg.CORBA.Any property_value)
Modifies or adds a property to the PropertySet . |
boolean |
delete_all_properties()
Variation of delete_properties . |
void |
delete_properties(java.lang.String[] property_names)
Deletes the properties defined in the property_names
parameter. |
void |
delete_property(java.lang.String property_name)
Deletes the specified property if it exists from a PropertySet . |
void |
get_all_properties(int how_many,
PropertiesHolder nproperties,
PropertiesIteratorHolder rest)
Returns all of the properties defined in the PropertySet . |
void |
get_all_property_names(int how_many,
PropertyNamesHolder property_names,
PropertyNamesIteratorHolder rest)
Returns all of the property names currently defined in the PropertySet . |
int |
get_number_of_properties()
Returns the current number of properties associated with this PropertySet . |
boolean |
get_properties(java.lang.String[] property_names,
PropertiesHolder nproperties)
Returns the values of the properties listed in property_names . |
org.omg.CORBA.Any |
get_property_value(java.lang.String property_name)
Returns the value of a property in the PropertySet . |
boolean |
is_property_defined(java.lang.String property_name)
The is_ property_defined operation returns
true if the property is defined in the
PropertySet , and returns false
otherwise. |
Methods inherited from class org.omg.CosPropertyService.PropertySetPOA |
---|
_all_interfaces, _invoke, _this, _this |
Methods inherited from class org.omg.PortableServer.Servant |
---|
_default_POA, _get_delegate, _get_interface_def, _is_a, _non_existent, _object_id, _orb, _poa, _set_delegate, _this_object, _this_object |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PropertySetImpl(org.omg.CORBA.ORB orb)
PropertySetImpl
.
orb
- the CORBA ORB.public PropertySetImpl(org.omg.CORBA.ORB orb, org.omg.CORBA.TypeCode[] allowed_property_types, Property[] allowed_properties) throws ConstraintNotSupported
PropertySetImpl
with
the specified constraints.
orb
- the CORBA ORB.allowed_property_types
- the list of allowed property types.allowed_properties
- the list of allowed properties. The constraint
is specified by the property's name, and its value's type.
ConstraintNotSupported
- if the type of a property in
allowed_properties
is not an allowed property
type; as specified by allowed_property_types
.public PropertySetImpl(org.omg.CORBA.ORB orb, Property[] initial_properties) throws MultipleExceptions
PropertySetImpl
with
the specified initial properties.
orb
- the CORBA ORB.initial_properties
- the list of properties initialize this
property set.
MultipleExceptions
- if an exception occurred
while defining the initial properties.Method Detail |
---|
public void define_property(java.lang.String property_name, org.omg.CORBA.Any property_value) throws InvalidPropertyName, ConflictingProperty, UnsupportedTypeCode, UnsupportedProperty, ReadOnlyProperty
PropertySet
. If
the property already exists, then the property type is checked
before the value is overwritten. If the property does not exist,
then the property is added to the PropertySet
.
To change the any
TypeCode
portion of
the property_value
of a property, a client must
first delete_property
, then invoke the
define_property
.
property_name
- the property name.property_value
- the property value.
InvalidPropertyName
- Indicates that the property name is
invalid (A property name of length 0 is invalid; implementations
may place other restrictions oneway property names.)
ConflictingProperty
- Indicates that the
property indicated
created a conflict in the type or value provided.
UnsupportedTypeCode
- Indicates that the any
TypeCode
of the property_value
field is not supported in this PropertySet
.
UnsupportedProperty
- Indicates that the supplied property
is not supported in this PropertySet
, either
due to PropertyName
restrictions or specific
name-value pair restrictions.
ReadOnlyProperty
- Indicates that the property does not
support client modification of the property_value
field.public void define_properties(Property[] nproperties) throws MultipleExceptions
Properties
parameter to the PropertySet
. For each property in the
list, if the property already exists, then the property type is
checked before overwriting the value. If the property does not exist,
then the property is added to the PropertySet
.
This is a batch operation that returns the MultipleExceptions
exception if any define operation failed.
nproperties
- the sequence of properties to define
MultipleExceptions
- The PropertyExceptions
sequence may contain any of the exceptions that may be
raised by the define_property
operation,
multiple times and in any order.public int get_number_of_properties()
PropertySet
.
PropertySet
.public void get_all_property_names(int how_many, PropertyNamesHolder property_names, PropertyNamesIteratorHolder rest)
PropertySet
. If the PropertySet
contains more than how_many
property names,
then the remaining property names are put into the
PropertyNamesIterator
.
how_many
- the number of property names to retrieve.property_names
- the sequence of property names retrieved
is returned in the output parameter.rest
- the iterator to return the remaining property
names.public org.omg.CORBA.Any get_property_value(java.lang.String property_name) throws PropertyNotFound, InvalidPropertyName
PropertySet
.
property_name
- the property name.
PropertyNotFound
- Indicates that the specified property
was not defined for this PropertySet
.
InvalidPropertyName
- Indicates the property name is
invalid. (A property name of length 0 is invalid; implementations may
place other restrictions oneway property names.)public boolean get_properties(java.lang.String[] property_names, PropertiesHolder nproperties)
property_names
.
When the boolean
flag is true
, the
Properties
parameter contains valid values for all
requested property names. If false
, then all
properties with a value of type tk_void
may have
failed due to PropertyNotFound
or
InvalidPropertyName
.
A separate invocation of get_property
for each such
property name is necessary to determine the specific exception or
to verify that tk_void
is the correct any
TypeCode
for that property name.
This approach was taken to avoid a complex, hard to program structure to carry mixed results.
property_names
- the sequence of property names.nproperties
- the properties are returned in the output parameter.
true
if the Properties
parameter
contains valid values for all requested property names. If
false
, properties with a value of type
tk_void
may have failed due to
PropertyNotFound
or InvalidPropertyName
.public void get_all_properties(int how_many, PropertiesHolder nproperties, PropertiesIteratorHolder rest)
PropertySet
.
If more than how_many
properties are found, then the
remaining properties are returned in rest
.
how_many
- the number of properties to retrieve.nproperties
- the sequence of properties retrieved is
returned in the output parameter.rest
- the iterator to return the remaining properties.public void delete_property(java.lang.String property_name) throws PropertyNotFound, InvalidPropertyName, FixedProperty
PropertySet
.
property_name
- the property name.
PropertyNotFound
- Indicates that the specified
property was
not defined for this PropertySet
.
InvalidPropertyName
- Indicates the property name
is invalid.
(A property name of length 0 is invalid; implementations may
place other restrictions oneway property names.)
FixedProperty
- Indicates that the PropertySet
does not support the deletion of the specified property.public void delete_properties(java.lang.String[] property_names) throws MultipleExceptions
property_names
parameter. This is a batch operation that returns the
MultipleExceptions
exception if any delete failed.
property_names
- the sequence of property names.
MultipleExceptions
- The PropertyExceptions
sequence may contain any of the exceptions that may be
raised by the delete_property
operation,
multiple times and in any order.public boolean delete_all_properties()
delete_properties
. Applies to all
properties.
Since some properties may be defined as fixed property types, it
may be that not all properties are deleted. The boolean
flag is set to false
to indicate that not all properties
were deleted.
A client could invoke get_number_of_properties
to
determine how many properties remain. Then invoke
get_all_property_names
to extract the property names
remaining. A separate invocation of delete_property
for each such property name is necessary to determine the specific
exception.
Note ? If the property is in a PropertySetDef
,
then the set_mode
operation could be invoked to attempt
to change the property mode to something other than fixed before
using delete_property
.
This approach was taken to avoid the use of an iterator to return an indeterminate number of exceptions.
false
if not all properties were deleted.public boolean is_property_defined(java.lang.String property_name) throws InvalidPropertyName
property_defined
operation returns
true
if the property is defined in the
PropertySet
, and returns false
otherwise.
property_name
- the property name.
InvalidPropertyName
- Indicates the property
name is invalid.
(A property name of length 0 is invalid; implementations may
place other restrictions oneway property names.)
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |