org.openorb.property
Class PropertySetDefImpl

java.lang.Object
  |
  +--org.omg.PortableServer.Servant
        |
        +--org.omg.CosPropertyService.PropertySetDefPOA
              |
              +--org.openorb.property.PropertySetDefImpl

All Implemented Interfaces:

org.omg.CORBA.portable.InvokeHandler, PropertySetDefOperations, PropertySetOperations

public class PropertySetDefImpl

extends PropertySetDefPOA

Author:

Jerome Daniel

Constructor Summary

PropertySetDefImpl(org.omg.CORBA.ORB orb)
Constructor

PropertySetDefImpl(org.omg.CORBA.ORB orb, PropertyDef[] initial_properties)
Constructor

PropertySetDefImpl(org.omg.CORBA.ORB orb, org.omg.CORBA.TypeCode[] allowed_property_types, PropertyDef[] allowed_properties)
Constructor

Method Summary

void	define_properties_with_modes(PropertyDef[] property_defs) This operation will modify or add each of the properties in the Properties parameter to the PropertySet.
void	define_properties(Property[] nproperties) Modify or add each of the properties in Properties parameter to the PropertySet.
void	define_property_with_mode(java.lang.String property_name, org.omg.CORBA.Any property_value, PropertyModeType property_mode) This operation will modify or add a property to the PropertySet.
void	define_property(java.lang.String property_name, org.omg.CORBA.Any property_value) Define_property will modify or add a property to the PropertySet.
boolean	delete_all_properties() Variation of delete_properties.
void	delete_properties(java.lang.String[] property_names) delete_properties Deletes the properties defined in the property_names parameter.
void	delete_property(java.lang.String property_name) delete_property 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.
void	get_allowed_properties(PropertyDefsHolder property_defs) Indicates which properties are supported by this PropertySet.
void	get_allowed_property_types(PropertyTypesHolder property_types) Indicates which types of properties are supported by this 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.
PropertyModeType	get_property_mode(java.lang.String property_name) Returns the mode of the property in the PropertySet.
boolean	get_property_modes(java.lang.String[] property_names, PropertyModesHolder property_modes) Returns the modes 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.
Property	get_property(java.lang.String property_name)
PropertyDef	get_propertydef(java.lang.String property_name)
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.
void	set_property_mode(java.lang.String property_name, PropertyModeType property_mode) Sets the mode of a property in the PropertySet.
void	set_property_modes(PropertyMode[] property_modes) Sets the mode for each property in the property_modes parameter.

Methods inherited from class org.omg.CosPropertyService.PropertySetDefPOA

_all_interfaces, _invoke, _this, _this

Methods inherited from class org.omg.PortableServer.Servant

_default_POA, _get_delegate, _get_interface_def, _get_interface, _is_a, _non_existent, _object_id, _orb, _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

PropertySetDefImpl

public PropertySetDefImpl(org.omg.CORBA.ORB orb)

Constructor

PropertySetDefImpl

public PropertySetDefImpl(org.omg.CORBA.ORB orb,
                          org.omg.CORBA.TypeCode[] allowed_property_types,
                          PropertyDef[] allowed_properties)
                   throws ConstraintNotSupported

Constructor

PropertySetDefImpl

public PropertySetDefImpl(org.omg.CORBA.ORB orb,
                          PropertyDef[] initial_properties)
                   throws MultipleExceptions

Constructor

Method Detail

get_allowed_property_types

public void get_allowed_property_types(PropertyTypesHolder property_types)

Indicates which types of properties are supported by this PropertySet. If the output sequence is empty, then there is no restrictions on the any TypeCode portion of the property_value field of a Property in this PropertySet, unless the get_allowed_properties output sequence is not empty. For example, a PropertySet implementation could decide to only accept properties that had any TypeCodes of tk_string and tk_ushort to simplify storage processing and retrieval.

get_allowed_properties

public void get_allowed_properties(PropertyDefsHolder property_defs)

Indicates which properties are supported by this PropertySet. If the output sequence is empty, then there is no restrictions on the properties that can be in this PropertySet, unless the get_allowed_property_types output sequence is not empty.

define_property_with_mode

public void define_property_with_mode(java.lang.String property_name,
                                      org.omg.CORBA.Any property_value,
                                      PropertyModeType property_mode)
                               throws InvalidPropertyName,
                                      ConflictingProperty,
                                      UnsupportedTypeCode,
                                      UnsupportedProperty,
                                      UnsupportedMode,
                                      ReadOnlyProperty

This operation will modify or add a property to the PropertySet. If the property already exists, then the property type is checked before the value is overwritten. The property mode is also checked to be sure a new value may be written. 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_with_mode.

define_properties_with_modes

public void define_properties_with_modes(PropertyDef[] property_defs)
                                  throws MultipleExceptions

This operation will modify or add each of the properties in the 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. The property mode is also checked to be sure a new value may be written. 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.

get_property_mode

public PropertyModeType get_property_mode(java.lang.String property_name)
                                   throws PropertyNotFound,
                                          InvalidPropertyName

Returns the mode of the property in the PropertySet.

get_property_modes

public boolean get_property_modes(java.lang.String[] property_names,
                                  PropertyModesHolder property_modes)

Returns the modes of the properties listed in property_names. when the boolean flag is true, the property_modes parameter contains valid values for all requested property names. If false, then all properties with a property_mode_type of undefined failed due to PropertyNotFound or InvalidPropertyName. A separate invocation of get_property_mode for each such property name is necessary to determine the specific exception for that property name. This approach was taken to avoid a complex, hard to program structure to carry mixed results.

set_property_mode

public void set_property_mode(java.lang.String property_name,
                              PropertyModeType property_mode)
                       throws InvalidPropertyName,
                              PropertyNotFound,
                              UnsupportedMode

Sets the mode of a property in the PropertySet. Protection of the mode of a property is considered an implementation issue. For example, an implementation could raise the UnsupportedMode when a client attempts to change a fixed_normal property to normal.

set_property_modes

public void set_property_modes(PropertyMode[] property_modes)
                        throws MultipleExceptions

Sets the mode for each property in the property_modes parameter. This is a batch operation that returns the MultipleExceptions exception if any set failed.

define_property

public void define_property(java.lang.String property_name,
                            org.omg.CORBA.Any property_value)
                     throws InvalidPropertyName,
                            ConflictingProperty,
                            UnsupportedTypeCode,
                            UnsupportedProperty,
                            ReadOnlyProperty

Define_property will modify or add a property to the 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.

define_properties

public void define_properties(Property[] nproperties)
                       throws MultipleExceptions

Modify or add each of the properties in 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.

get_number_of_properties

public int get_number_of_properties()

Returns the current number of properties associated with this PropertySet.

get_all_property_names

public void get_all_property_names(int how_many,
                                   PropertyNamesHolder property_names,
                                   PropertyNamesIteratorHolder rest)

Returns all of the property names currently defined in the PropertySet. If the PropertySet contains more than how_many property names, then the remaining property names are put into the PropertyNamesIterator.

get_property_value

public org.omg.CORBA.Any get_property_value(java.lang.String property_name)
                                     throws PropertyNotFound,
                                            InvalidPropertyName

Returns the value of a property in the PropertySet.

get_properties

public boolean get_properties(java.lang.String[] property_names,
                              PropertiesHolder nproperties)

Returns the values of the properties listed in 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.

get_propertydef

public PropertyDef get_propertydef(java.lang.String property_name)
                            throws PropertyNotFound,
                                   InvalidPropertyName

get_property

public Property get_property(java.lang.String property_name)
                      throws PropertyNotFound,
                             InvalidPropertyName

get_all_properties

public void get_all_properties(int how_many,
                               PropertiesHolder nproperties,
                               PropertiesIteratorHolder rest)

Returns all of the properties defined in the PropertySet. If more than how_many properties are found, then the remaining properties are returned in rest

delete_property

public void delete_property(java.lang.String property_name)
                     throws PropertyNotFound,
                            InvalidPropertyName,
                            FixedProperty

delete_property Deletes the specified property if it exists from a PropertySet.

delete_properties

public void delete_properties(java.lang.String[] property_names)
                       throws MultipleExceptions

delete_properties Deletes the properties defined in the property_names parameter. This is a batch operation that returns the MultipleExceptions exception if any delete failed.

delete_all_properties

public boolean delete_all_properties()

Variation of 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.

is_property_defined

public boolean is_property_defined(java.lang.String property_name)
                            throws InvalidPropertyName

The is_property_defined operation returns true if the property is defined in the PropertySet, and returns false otherwise.