My Project
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
resqml2_0_1::StringTableLookup Class Reference
Inheritance diagram for resqml2_0_1::StringTableLookup:
resqml2::AbstractObject

Public Member Functions

 StringTableLookup ()
 
 StringTableLookup (soap *soapContext, const std::string &guid, const std::string &title)
 
 StringTableLookup (gsoap_resqml2_0_1::_resqml2__StringTableLookup *fromGsoap)
 
 ~StringTableLookup ()
 
virtual std::string getXmlTag () const
 
void addCategoricalPropertyValues (class CategoricalProperty *categVal)
 
bool containsKey (const long &longValue)
 
unsigned int getItemCount () const
 
long getKeyAtIndex (const unsigned int &index) const
 
std::string getStringValueAtIndex (const unsigned int &index) const
 
std::string getStringValue (const long &longValue)
 
void addValue (const std::string &strValue, const long &longValue)
 
void setValue (const std::string &strValue, const long &longValue)
 
std::tr1::unordered_map< long, std::string > getMap () const
 
- Public Member Functions inherited from resqml2::AbstractObject
bool isPartial () const
 
std::string getUuid () const
 
std::string getTitle () const
 
std::string getEditor () const
 
time_t getCreation () const
 
std::string getOriginator () const
 
std::string getDescription () const
 
time_t getLastUpdate () const
 
std::string getFormat () const
 
std::string getDescriptiveKeywords () const
 
void setTitle (const std::string &title)
 
void setEditor (const std::string &editor)
 
void setCreation (const time_t &creation)
 
void setOriginator (const std::string &originator)
 
void setDescription (const std::string &description)
 
void setLastUpdate (const time_t &lastUpdate)
 
void setFormat (const std::string &format)
 
void setDescriptiveKeywords (const std::string &descriptiveKeywords)
 
void setMetadata (const std::string &title, const std::string &editor, const time_t &creation, const std::string &originator, const std::string &description, const time_t &lastUpdate, const std::string &format, const std::string &descriptiveKeywords)
 
void serializeIntoStream (std::ostream *stream)
 
gsoap_resqml2_0_1::eml__AbstractCitedDataObject * getGsoapProxy () const
 
soap * getGsoapContext () const
 
int getGsoapType () const
 
gsoap_resqml2_0_1::eml__DataObjectReference * newResqmlReference () const
 
gsoap_resqml2_0_1::resqml2__ContactElementReference * newResqmlContactElementReference () const
 
common::EpcDocument * getEpcDocument () const
 
virtual std::string getXmlNamespace () const
 
virtual std::string getResqmlVersion () const
 
std::string getContentType () const
 
std::string getPartNameInEpcDocument () const
 
std::string serializeIntoString ()
 
void addAlias (const std::string &authority, const std::string &title)
 
unsigned int getAliasCount () const
 
std::string getAliasAuthorityAtIndex (const unsigned int &index) const
 
std::string getAliasTitleAtIndex (const unsigned int &index) const
 
const std::vector< resqml2::Activity * > & getActivitySet () const
 
void addOrSetExtraMetadata (const std::string &key, const std::string &value)
 
std::tr1::unordered_map< std::string, std::string > getExtraMetadataSet () const
 
std::string getExtraMetadata (const std::string &key)
 
unsigned int getExtraMetadataCount () const
 
std::string getExtraMetadataKeyAtIndex (const unsigned int &index) const
 
std::string getExtraMetadataStringValueAtIndex (const unsigned int &index) const
 

Static Public Attributes

static const char * XML_TAG = "StringTableLookup"
 

Protected Member Functions

std::vector< epc::Relationship > getAllEpcRelationships () const
 
void importRelationshipSetFromEpc (common::EpcDocument *epcDoc)
 
- Protected Member Functions inherited from resqml2::AbstractObject
 AbstractObject (common::EpcDocument *epcDoc, gsoap_resqml2_0_1::eml__DataObjectReference *partialObject)
 Indicate whether methods update the XML (gSoap) or only the C++ classes of the API. More...
 
 AbstractObject (gsoap_resqml2_0_1::eml__AbstractCitedDataObject *proxy=nullptr)
 
void initMandatoryMetadata ()
 
void setMetadata (const std::string &guid, const std::string &title, const std::string &editor, const time_t &creation, const std::string &originator, const std::string &description, const time_t &lastUpdate, const std::string &format, const std::string &descriptiveKeywords)
 

Protected Attributes

std::vector< class CategoricalProperty * > categoricalPropertyValuesSet
 
- Protected Attributes inherited from resqml2::AbstractObject
gsoap_resqml2_0_1::eml__AbstractCitedDataObject * gsoapProxy2_0_1
 
common::EpcDocument * epcDocument
 
std::vector< resqml2::Activity * > activitySet
 
bool updateXml
 

Additional Inherited Members

- Static Protected Member Functions inherited from resqml2::AbstractObject
static void addActivityToResqmlObject (resqml2::Activity *activity, AbstractObject *resqmlObject)
 

Constructor & Destructor Documentation

resqml2_0_1::StringTableLookup::StringTableLookup ( )
inline

Default constructor

resqml2_0_1::StringTableLookup::StringTableLookup ( soap *  soapContext,
const std::string &  guid,
const std::string &  title 
)

Creates an instance of this class in a gsoap context.

Parameters
soapA gsoap context wihch will manage the memory and the serialization/deserialization of this instance.
guidThe guid to set to this instance. If empty then a new guid will be generated.
titleA title for the instance to create.
resqml2_0_1::StringTableLookup::StringTableLookup ( gsoap_resqml2_0_1::_resqml2__StringTableLookup *  fromGsoap)
inline

Creates an instance of this class by wrapping a gsoap instance.

resqml2_0_1::StringTableLookup::~StringTableLookup ( )
inline

Destructor does nothing since the memory is managed by the gsoap context.

Member Function Documentation

void resqml2_0_1::StringTableLookup::addCategoricalPropertyValues ( class CategoricalProperty *  categVal)
inline

Add a categorical property values object which uses this string lookup. Does not add the inverse relationship i.e. from the categorical property values object to this string lookup.

void StringTableLookup::addValue ( const std::string &  strValue,
const long &  longValue 
)

Add a pair value to the string lookup. No verification that the key value (or string value) already exists

bool StringTableLookup::containsKey ( const long &  longValue)

Check wether a key value is contained within this string lookup or not.

vector< Relationship > StringTableLookup::getAllEpcRelationships ( ) const
protectedvirtual

Return all relationships (backward and forward ones) of the instance using EPC format.

Implements resqml2::AbstractObject.

unsigned int StringTableLookup::getItemCount ( ) const

Get the count of item in the stringTableLookup (in the map).

long StringTableLookup::getKeyAtIndex ( const unsigned int &  index) const

Get the key of a string value pair at a particular index in the string table lookup (in the map)

std::string StringTableLookup::getStringValue ( const long &  longValue)

Get a string value from its associated key (long) value. If the key value does not exist, an empty string is returned.

std::string StringTableLookup::getStringValueAtIndex ( const unsigned int &  index) const

Get the string value of a string value pair at a particular index in the string table lookup (in the map)

virtual std::string resqml2_0_1::StringTableLookup::getXmlTag ( ) const
inlinevirtual

Get the XML tag for the XML serialization of this instance

Implements resqml2::AbstractObject.

void resqml2_0_1::StringTableLookup::importRelationshipSetFromEpc ( common::EpcDocument *  epcDoc)
inlineprotectedvirtual

Does nothing since StringTableLookup has not got any forward relationship.

Implements resqml2::AbstractObject.

void StringTableLookup::setValue ( const std::string &  strValue,
const long &  longValue 
)

Modify the associated string value according to the key (long) value. If the key value does not exist, nothing is done.

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.11