TAO_Offer_Modifier Class Reference

This class deletes, modifies, and adds properties to a given offer according to the rules of the modify method on the Register interface. More...

#include <Trader_Utils.h>

Collaboration diagram for TAO_Offer_Modifier:

[legend]List of all members.

Public Member Functions
	TAO_Offer_Modifier (const char *type, const CosTradingRepos::ServiceTypeRepository::TypeStruct &type_struct, CosTrading::Offer *offer)
	~TAO_Offer_Modifier (void)
void	delete_properties (const CosTrading::PropertyNameSeq &deletes)
void	merge_properties (const CosTrading::PropertySeq &modifies)
void	affect_change (const CosTrading::PropertySeq &modifies)
	Return a reference to the Offer with the changes affected.
Private Types
typedef ACE_Hash_Map_Manager_Ex< CORBA::String_var, CosTrading::Property *, ACE_Hash< CORBA::String_var >, ACE_Equal_To< CORBA::String_var >, ACE_Null_Mutex >	Property_Table
Private Member Functions
	TAO_Offer_Modifier (const TAO_Offer_Modifier &)
TAO_Offer_Modifier &	operator= (const TAO_Offer_Modifier &)
Private Attributes
const char *	type_
	The type of the offer.
Property_Table	props_
	The map of properties in the offer.
TAO_Typecode_Table	prop_types_
	Table of property types.
TAO_String_Set	readonly_
TAO_String_Set	mandatory_
CosTrading::Offer *	offer_
	A reference to the offer undergoing change.

---

Detailed Description

This class deletes, modifies, and adds properties to a given offer according to the rules of the modify method on the Register interface.

Definition at line 546 of file Trader_Utils.h.

---

Member Typedef Documentation

typedef ACE_Hash_Map_Manager_Ex<CORBA::String_var, CosTrading::Property *, ACE_Hash<CORBA::String_var>, ACE_Equal_To<CORBA::String_var>, ACE_Null_Mutex> TAO_Offer_Modifier::Property_Table [private]

Definition at line 583 of file Trader_Utils.h.

---

Constructor & Destructor Documentation

TAO_Offer_Modifier::TAO_Offer_Modifier	(	const char *	type,
		const CosTradingRepos::ServiceTypeRepository::TypeStruct &	type_struct,
		CosTrading::Offer *	offer
	)

Modify an <offer> of type <type>, whose properties are described by <type_struct>

Definition at line 978 of file Trader_Utils.cpp.

References ACE_Hash_Map_Manager_Ex< EXT_ID, INT_ID, HASH_KEY, COMPARE_KEYS, ACE_LOCK >::bind(), ACE_Unbounded_Set_Ex< T, C >::insert(), mandatory_, offer_, CosTradingRepos::ServiceTypeRepository::PROP_MANDATORY, CosTradingRepos::ServiceTypeRepository::PROP_READONLY, prop_types_, CosTrading::Offer::properties, CosTradingRepos::ServiceTypeRepository::TypeStruct::props, props_, and readonly_.

  : type_ (type_name),
    offer_ (offer)
{
  const CosTradingRepos::ServiceTypeRepository::PropStructSeq&
    pstructs = type_struct.props;
  CosTrading::PropertySeq& prop_seq = this->offer_->properties;
  CORBA::ULong pstructs_length = pstructs.length (),
    props_length = prop_seq.length (),
    i = 0;

  // Create a mapping of property names to their types.
  for (i = 0; i < pstructs_length; i++)
    {
      CORBA::String_var prop_name = pstructs[i].name.in ();
      CORBA::TypeCode_ptr type_code =
        CORBA::TypeCode::_duplicate (pstructs[i].value_type.in ());
      this->prop_types_.bind (prop_name, type_code);
    }

  // Separate the type defined properties into mandatory and readonly
  for (i = 0; i < pstructs_length; i++)
    {
      const char* pname = pstructs[i].name;

      if (pstructs[i].mode ==
          CosTradingRepos::ServiceTypeRepository::PROP_MANDATORY)
        {
          CORBA::String_var prop_name (pname);
          this->mandatory_.insert (prop_name);
        }
      else if (pstructs[i].mode ==
               CosTradingRepos::ServiceTypeRepository::PROP_READONLY)
        {
          CORBA::String_var prop_name (pname);
          this->readonly_.insert (prop_name);
        }
    }

  // Insert the indices of the offer properties into a map.
  for (i = 0; i < props_length; i++)
    {
      CORBA::String_var prop_name =
        static_cast<const char*> (prop_seq[i].name);
      this->props_.bind (prop_name, &prop_seq[i]);
    }
}

TAO_Offer_Modifier::~TAO_Offer_Modifier

(

void

)

Definition at line 1028 of file Trader_Utils.cpp.

References CORBA::release().

{
  for (TAO_Typecode_Table::iterator type_iter (this->prop_types_);
       ! type_iter.done ();
       type_iter++)
    {
      CORBA::TypeCode_ptr corba_type = (*type_iter).int_id_;
      CORBA::release (corba_type);
    }
}

TAO_Offer_Modifier::TAO_Offer_Modifier

(

const TAO_Offer_Modifier &

)

[private]

---

Member Function Documentation

void TAO_Offer_Modifier::affect_change

(

const CosTrading::PropertySeq &

modifies

)

Return a reference to the Offer with the changes affected.

Definition at line 1134 of file Trader_Utils.cpp.

References ACE_Hash_Map_Manager_Ex< EXT_ID, INT_ID, HASH_KEY, COMPARE_KEYS, ACE_LOCK >::current_size(), offer_, CosTrading::Offer::properties, and props_.

{
  // Create a new property list reflecting the deletes, modifies, and
  // add operations performed, and place this property list in the
  // offer.

  // Merge these properties with the original set.
  CORBA::ULong i = 0,
    merge_length = modifies.length ();

  for (i = 0; i < merge_length; i++)
    {
      Property_Table::ENTRY* entry = 0;
      CORBA::String_var prop_name = modifies[i].name.in ();

      CosTrading::Property* prop =
        const_cast<CosTrading::Property*> (&modifies[i]);
      if (this->props_.bind (prop_name, prop, entry) == 1)
        // We need to rebind here.
        entry->int_id_ = prop;
    }

  CORBA::ULong num_modified = 0,
    original_length = this->offer_->properties.length (),
    total_length = static_cast<CORBA::ULong> (this->props_.current_size ());

  // Scrap the existing property sequence and begin a new one
  CosTrading::PropertySeq prop_seq (total_length);
  //  this->offer_->properties.length (total_length);

  // Copy in the unaffected and modified props into the offer,
  // excluding those that were deleted. Let's try and retain their
  // relative ordering.
  for (i = 0; i < original_length; i++)
    {
      CosTrading::Property* prop_value = 0;
      const char* name = this->offer_->properties[i].name;
      CORBA::String_var prop_name (name);
      if (this->props_.unbind (prop_name, prop_value) == 0)
        prop_seq[num_modified++] = *prop_value;
    }

  for (i = 0; i < merge_length; i++)
    {
      CosTrading::Property* prop_value = 0;
      const char* name = modifies[i].name;
      CORBA::String_var prop_name (name);
      if (this->props_.unbind (prop_name, prop_value) == 0)
        prop_seq[num_modified++] = *prop_value;
    }

  this->offer_->properties.length (total_length);
  for (i = 0; i < total_length; i++)
    this->offer_->properties[i] = prop_seq[i];
  // Free the old, orphaned sequence.
  //  CosTrading::PropertySeq::freebuf (prop_buf);
}

void TAO_Offer_Modifier::delete_properties

(

const CosTrading::PropertyNameSeq &

deletes

)

Delete the properties whose names were given to the constructor. Ensure we don't delete mandatory properties.

Definition at line 1041 of file Trader_Utils.cpp.

References ACE_Unbounded_Set_Ex< T, C >::insert(), TAO_Trader_Base::is_valid_property_name(), props_, and ACE_Hash_Map_Manager_Ex< EXT_ID, INT_ID, HASH_KEY, COMPARE_KEYS, ACE_LOCK >::unbind().

{
  // Validate that the listed property names can be deleted
  CORBA::ULong i = 0,
    length = deletes.length ();
  TAO_String_Set delete_me;

  for (i = 0; i < length; i++)
    {
      const char* dname = static_cast<const char*> (deletes[i]);
      if (! TAO_Trader_Base::is_valid_property_name (dname))
        throw CosTrading::IllegalPropertyName (dname);
      else
        {
          CORBA::String_var prop_name (dname);
          if (this->mandatory_.find (prop_name) == 0)
            throw CosTrading::Register::MandatoryProperty (this->type_, dname);
          else if (delete_me.insert (prop_name) == 1)
            throw CosTrading::DuplicatePropertyName (dname);
          else if (this->props_.find (prop_name) == -1)
            throw CosTrading::Register::UnknownPropertyName (dname);
        }
    }

  // Delete those properties from the offer.
  for (i = 0; i < length; i++)
    {
      CORBA::String_var prop_name =
        static_cast<const char *> (deletes[i]);
      this->props_.unbind (prop_name);
    }
}

void TAO_Offer_Modifier::merge_properties

(

const CosTrading::PropertySeq &

modifies

)

Copy to the destination the union of the source and destination properties. In the case of duplicate properties, update the destination with the source's value. This class claims the memory in the modifies sequence.

Definition at line 1076 of file Trader_Utils.cpp.

References ACE_Unbounded_Set_Ex< T, C >::insert(), TAO_Property_Evaluator::is_dynamic_property(), TAO_Trader_Base::is_valid_property_name(), and TAO_Property_Evaluator::property_type().

{
  int i = 0, length = 0;
  TAO_String_Set modify_me;

  // Ensure that the proposed changes aren't to readonly properties or
  // otherwise invalid.
  TAO_Property_Evaluator prop_eval (modifies);
  for (i = 0, length = modifies.length (); i < length; i++)
    {
      const char* mname = modifies[i].name;
      if (TAO_Trader_Base::is_valid_property_name (mname))
        {
          CORBA::String_var prop_name (mname);
          if (this->readonly_.find (prop_name) == 0)
            {
              // Can't assign a dynamic property to a property with
              // readonly mode, and can't reassign a readonly property.
              if (prop_eval.is_dynamic_property (i))
                throw CosTrading::ReadonlyDynamicProperty (this->type_, mname);
              else if (this->props_.find (prop_name) == 0)
                throw CosTrading::Register::ReadonlyProperty (
                  this->type_,
                  mname);
            }

          // Validate the property type if the property is defined in
          // the service type description.
          CORBA::TypeCode_ptr type_def = 0;
          if (this->prop_types_.find (prop_name, type_def) == 0)
            {
              CORBA::TypeCode_var prop_type = prop_eval.property_type (i);

              // @@ Frank: This code used to have this comment and line
              //    of code before I fixed the "ACE_TRY" fuzz warning here.
              // @@ Seth, are we trying to ignore the exception here?
              // CORBA::Environment ACE_TRY_ENV;
              // @@ Frank: It seems clear that this is not going to work as
              // expected.  Is the purpose to ignore any exceptions from
              // equal ()?  For now, exceptions are returned since this
              // seemed "safest".

              CORBA::Boolean td_equal =
                type_def->equal (prop_type.in ());

              if (!td_equal)
                throw CosTrading::PropertyTypeMismatch (mname, modifies[i]);
            }

          if (modify_me.insert (prop_name) == 1)
            throw CosTrading::DuplicatePropertyName (mname);
        }
      else
        throw CosTrading::IllegalPropertyName (mname);
    }
}

TAO_Offer_Modifier& TAO_Offer_Modifier::operator=

(

const TAO_Offer_Modifier &

)

[private]

---

Member Data Documentation

TAO_String_Set TAO_Offer_Modifier::mandatory_ [private]

Definition at line 597 of file Trader_Utils.h.

Referenced by TAO_Offer_Modifier().

CosTrading::Offer* TAO_Offer_Modifier::offer_ [private]

A reference to the offer undergoing change.

Definition at line 600 of file Trader_Utils.h.

Referenced by affect_change(), and TAO_Offer_Modifier().

TAO_Typecode_Table TAO_Offer_Modifier::prop_types_ [private]

Table of property types.

Definition at line 592 of file Trader_Utils.h.

Referenced by TAO_Offer_Modifier().

Property_Table TAO_Offer_Modifier::props_ [private]

The map of properties in the offer.

Definition at line 589 of file Trader_Utils.h.

Referenced by affect_change(), delete_properties(), and TAO_Offer_Modifier().

TAO_String_Set TAO_Offer_Modifier::readonly_ [private]

The set of readonly and mandatory property names in the offer's type.

Definition at line 596 of file Trader_Utils.h.

Referenced by TAO_Offer_Modifier().

const char* TAO_Offer_Modifier::type_ [private]

The type of the offer.

Definition at line 586 of file Trader_Utils.h.

---

The documentation for this class was generated from the following files:

• Trader_Utils.h
• Trader_Utils.cpp

---