Jive reference manual
List of all members | Public Member Functions | Protected Member Functions
jive::util::DummyItemSet Class Reference

#include <jive/util/DummyItemSet.h>

Inheritance diagram for jive::util::DummyItemSet:
Inheritance graph

Public Member Functions

 DummyItemSet ()
 
 DummyItemSet (const String &name, const String &item="item", const Ref< XItemMap > &map=NIL)
 
 DummyItemSet (const Self &rhs)
 
virtual void resetEvents ()
 
virtual void readFrom (ObjectInput &in)
 
virtual void writeTo (ObjectOutput &out) const
 
virtual Ref< Objectclone () const
 
virtual idx_t size () const
 Returns the size of this item set. More...
 
virtual String getItemName () const
 Returns the type name of an item. More...
 
virtual ItemMapgetItemMap () const
 Returns the item map associated with this item set. More...
 
virtual void clear ()
 
void reserve (idx_t count)
 
void trimToSize ()
 
idx_t addItem ()
 
idx_t addItem (idx_t itemID)
 
idx_t addItems (idx_t count)
 
idx_t addItems (const IdxVector &itemIDs)
 
void eraseItems (const IdxVector &iitems)
 
void reorderItems (const Reordering &reord)
 
virtual void printSubset (PrintWriter &out, const IdxVector &iitems) const
 
- Public Member Functions inherited from jive::util::ItemSet
virtual String toString () const
 Returns a short textual description of this object. More...
 
String getName () const
 Returns the (descriptive) name of this item set. More...
 
virtual String getTagName () const
 Returns an XML tag name for this item set. More...
 
virtual String getItemsName () const
 Returns the plural of an item type name. More...
 
String getContext () const
 Returns a context string. More...
 
String getItemPath (int itemID) const
 Returns an identification string for an item. More...
 
int findItem (int itemID) const
 Returns the index of an item with a given ID. More...
 
int getItemID (int iitem) const
 Returns the ID of the item with a given index. More...
 
virtual void printTo (Printer &out) const
 Prints the contents of this item set. More...
 
void store (const String &name, const Properties &globdat) const
 Stores this item set in a (global) data set. More...
 
- Public Member Functions inherited from jem::Object
virtual ClassgetClass () const
 Returns the Class instance representing the runtime class of this object. More...
 
virtual long hashValue () const
 Returns a hash value for this object. More...
 
virtual bool equals (const Ref< Object > &obj) const
 Tests whether two objects are equal. More...
 
Ref< Objectclone () const
 Returns a copy of this object. More...
 

Protected Member Functions

virtual ~DummyItemSet ()
 
virtual void emitEvents_ (int events)
 
- Protected Member Functions inherited from jive::util::ItemSet
 ItemSet (const String &name="")
 Constructs an item set with a given name. More...
 
virtual ~ItemSet ()
 
- Protected Member Functions inherited from jem::Collectable
 Collectable ()
 Creates an empty Collectable. More...
 
 ~Collectable ()
 Frees resources. More...
 
- Protected Member Functions inherited from jem::Clonable
virtual ~Clonable ()
 
virtual void emitVTable_ ()
 
- Protected Member Functions inherited from jem::Interface
virtual ~Interface ()
 Empty destructor. More...
 
- Protected Member Functions inherited from jem::io::Serializable
virtual ~Serializable ()
 
virtual void emitVtableFunc_ ()
 

Additional Inherited Members

- Public Types inherited from jive::util::ItemSet
typedef jem::String String
 Represents a string type. More...
 
typedef jem::io::PrintWriter Printer
 Represents a formatted output stream. More...
 
typedef jem::util::Dictionary Dict
 Represents a dictionary. More...
 
typedef jem::util::Properties Properties
 Represents a properties set. More...
 
- Static Public Member Functions inherited from jive::util::ItemSet
static jem::Ref< ItemSetfind (const String &name, const Properties &globdat)
 Searches for a named item set in a (global) data set. More...
 
static jem::Ref< ItemSetget (const String &name, const Properties &globdat, const String &context)
 Returns a named item set stored in a (global) data set. More...
 
static jem::Ref< DictgetAll (const Properties &globdat)
 Returns a dictionary containing all item sets in a (global) data set. More...
 
static StringVector listAll (const Properties &globdat)
 Returns the names of all item sets stored in a (global) data set. More...
 
- Static Public Member Functions inherited from jem::Object
static ClassgetType ()
 Returns the Class instance representing the Object class. More...
 
- Public Attributes inherited from jive::util::ItemSet
jem::util::Event< int, Self & > newSizeEvent
 Signals that the size of this item set has changed. More...
 
jem::util::Event< const IntVector &, Self & > newOrderEvent
 Signals that the items have been re-ordered. More...
 
- Protected Attributes inherited from jive::util::ItemSet
String myName_
 The descriptive name of this item set. More...
 

Constructor & Destructor Documentation

jive::util::DummyItemSet::DummyItemSet ( )
jive::util::DummyItemSet::DummyItemSet ( const String name,
const String item = "item",
const Ref< XItemMap > &  map = NIL 
)
explicit
jive::util::DummyItemSet::DummyItemSet ( const Self &  rhs)
virtual jive::util::DummyItemSet::~DummyItemSet ( )
protectedvirtual

Member Function Documentation

virtual void jive::util::DummyItemSet::resetEvents ( )
virtual
virtual void jive::util::DummyItemSet::readFrom ( ObjectInput in)
virtual

Implements jem::io::Serializable.

virtual void jive::util::DummyItemSet::writeTo ( ObjectOutput out) const
virtual

Implements jem::io::Serializable.

virtual Ref<Object> jive::util::DummyItemSet::clone ( ) const
virtual

Implements jem::Clonable.

virtual idx_t jive::util::DummyItemSet::size ( ) const
virtual

Returns the number of items in this set.

Returns
The number of items in this item set.

Reimplemented from jive::util::ItemSet.

virtual String jive::util::DummyItemSet::getItemName ( ) const
virtual

Returns a string that can be used as the type name of an item in this set. For instance, if this item sets contains points, it could return the string "point".

The string returned by this function is mostly used to generate various types of output messagesm, including error messages.

Returns
A string denoting the type of items in this set.

Implements jive::util::ItemSet.

virtual ItemMap* jive::util::DummyItemSet::getItemMap ( ) const
virtual

Returns a pointer to the ItemMap object that is associated with this item set. The pointer is guaranteed to be non-null and to be valid throughout the lifetime of this item set.

Returns
A pointer to the ItemMap of this item set.

Implements jive::util::ItemSet.

virtual void jive::util::DummyItemSet::clear ( )
virtual
void jive::util::DummyItemSet::reserve ( idx_t  count)
void jive::util::DummyItemSet::trimToSize ( )
idx_t jive::util::DummyItemSet::addItem ( )
idx_t jive::util::DummyItemSet::addItem ( idx_t  itemID)
idx_t jive::util::DummyItemSet::addItems ( idx_t  count)
idx_t jive::util::DummyItemSet::addItems ( const IdxVector &  itemIDs)
void jive::util::DummyItemSet::eraseItems ( const IdxVector &  iitems)
void jive::util::DummyItemSet::reorderItems ( const Reordering reord)
virtual void jive::util::DummyItemSet::printSubset ( PrintWriter out,
const IdxVector &  iitems 
) const
virtual
virtual void jive::util::DummyItemSet::emitEvents_ ( int  events)
protectedvirtual