copasi API  0.1
Classes | Public Types | Public Member Functions | Static Public Member Functions | Friends
CRDFPredicate Class Reference

#include <CRDFPredicate.h>

List of all members.

Classes

struct  sAllowedLocation

Public Types

enum  ePredicateType {
  copasi_encodes = 0, copasi_hasPart, copasi_hasVersion, copasi_is,
  copasi_isDescribedBy, copasi_isEncodedBy, copasi_isHomologTo, copasi_isPartOf,
  copasi_isVersionOf, copasi_occursIn, bqbiol_encodes, bqbiol_hasPart,
  bqbiol_hasVersion, bqbiol_is, bqbiol_isDescribedBy, bqbiol_isEncodedBy,
  bqbiol_isHomologTo, bqbiol_isPartOf, bqbiol_isVersionOf, bqbiol_occursIn,
  bqmodel_is, bqmodel_isDescribedBy, dc_creator, dcterms_creator,
  dcterms_bibliographicCitation, dcterms_created, dcterms_description, dcterms_modified,
  dcterms_W3CDTF, vcard_EMAIL, vcard_Family, vcard_Given,
  vcard_N, vcard_ORG, vcard_Orgname, rdf_type,
  rdf_li, rdf__n, rdf_subject, rdf_predicate,
  rdf_object, unknown, about, any,
  end
}
typedef std::vector
< ePredicateType
Path
typedef std::vector
< sAllowedLocation
AllowedLocationList

Public Member Functions

 CRDFPredicate (const ePredicateType &type=end)
 CRDFPredicate (const std::string &uri)
 CRDFPredicate (const CRDFPredicate &src)
 ~CRDFPredicate ()
CRDFPredicate operator= (const ePredicateType &type)
const std::string & getURI () const
void setURI (const std::string &uri)
bool operator== (const CRDFPredicate &rhs) const
bool operator!= (const CRDFPredicate &rhs) const
bool operator< (const CRDFPredicate &rhs) const
const ePredicateTypegetType () const

Static Public Member Functions

static const AllowedLocationListgetAllowedLocationList (const ePredicateType &predicate)
static const std::string & getURI (const CRDFPredicate &predicate)
static ePredicateType getPredicateFromURI (const std::string &URI)
static const std::string & getDisplayName (const CRDFPredicate &predicate)
static ePredicateType getPredicateFromDisplayName (const std::string &displayName)
static size_t getSubPathIndex (const Path &fullPath, const Path &currentPath)
static bool isReadOnly (const Path &currentPath)

Friends

std::ostream & operator<< (std::ostream &os, const CRDFPredicate &p)

Member Typedef Documentation

typedef std::vector< ePredicateType > CRDFPredicate::Path

Member Enumeration Documentation

Enumerator:
copasi_encodes 
copasi_hasPart 
copasi_hasVersion 
copasi_is 
copasi_isDescribedBy 
copasi_isEncodedBy 
copasi_isHomologTo 
copasi_isPartOf 
copasi_isVersionOf 
copasi_occursIn 
bqbiol_encodes 
bqbiol_hasPart 
bqbiol_hasVersion 
bqbiol_is 
bqbiol_isDescribedBy 
bqbiol_isEncodedBy 
bqbiol_isHomologTo 
bqbiol_isPartOf 
bqbiol_isVersionOf 
bqbiol_occursIn 
bqmodel_is 
bqmodel_isDescribedBy 
dc_creator 
dcterms_creator 
dcterms_bibliographicCitation 
dcterms_created 
dcterms_description 
dcterms_modified 
dcterms_W3CDTF 
vcard_EMAIL 
vcard_Family 
vcard_Given 
vcard_N 
vcard_ORG 
vcard_Orgname 
rdf_type 
rdf_li 
rdf__n 
rdf_subject 
rdf_predicate 
rdf_object 
unknown 
about 
any 
end 

Constructor & Destructor Documentation

CRDFPredicate::CRDFPredicate ( const ePredicateType type = end)

Default constructor

Parameters:
constePredicateType & type (default CRDFPredicate::end)
CRDFPredicate::CRDFPredicate ( const std::string &  uri)

Specific constructor

Parameters:
conststd::string & uri
CRDFPredicate::CRDFPredicate ( const CRDFPredicate src)

Copy constructor

Parameters:
constCRDFPredicate & src
CRDFPredicate::~CRDFPredicate ( )

Destructor


Member Function Documentation

const CRDFPredicate::AllowedLocationList & CRDFPredicate::getAllowedLocationList ( const ePredicateType predicate) [static]

Retrieve the list of allowed locations in the RDF graph for the given predicate

Parameters:
constePredicateType & predicate
Returns:
const AllowedLocationList & listOfAllowedLocations
const std::string & CRDFPredicate::getDisplayName ( const CRDFPredicate predicate) [static]

Retrieve the display name for the given predicate

Parameters:
constCRDFPredicate & predicate
Returns:
const std::string & displayName
CRDFPredicate::ePredicateType CRDFPredicate::getPredicateFromDisplayName ( const std::string &  displayName) [static]

Retrieve the type of predicate from the given display name

Parameters:
conststd::string & displayName
Returns:
ePredicateType type
CRDFPredicate::ePredicateType CRDFPredicate::getPredicateFromURI ( const std::string &  URI) [static]

Retrieve the type of predicate for the given URI

Parameters:
conststd::string & URI
Returns:
ePredicateType type
size_t CRDFPredicate::getSubPathIndex ( const Path fullPath,
const Path currentPath 
) [static]

Retrieve the index of the next path element of the full path beyond the current path. If the current path is not part of the full path C_INVALID_INDEX is returned

Parameters:
constPath & fullPath
constPath & currentPath
Returns:
size_t index
const CRDFPredicate::ePredicateType & CRDFPredicate::getType ( ) const

Retrieve the type og the predicate.

Returns:
const ePredicateType & type
const std::string & CRDFPredicate::getURI ( ) const

Retrieve the URI.

Returns:
const std::string & URI
const std::string & CRDFPredicate::getURI ( const CRDFPredicate predicate) [static]

Retrieve the URI for the given predicate

Parameters:
constCRDFPredicate & predicate
Returns:
const std::string & uri
bool CRDFPredicate::isReadOnly ( const Path currentPath) [static]

Checks whether the element pointed to by the current path is read-only

Parameters:
constPath & currentPath
Returns:
bool isReadOnly
bool CRDFPredicate::operator!= ( const CRDFPredicate rhs) const

Comparison operator for inequality.

Parameters:
constCRDFPredicate & rhs
Returns:
bool isNotEqual
bool CRDFPredicate::operator< ( const CRDFPredicate rhs) const

Comparison operator for less.

Parameters:
constCRDFPredicate & rhs
Returns:
bool isLess
CRDFPredicate CRDFPredicate::operator= ( const ePredicateType type)

Assignment operator.

Parameters:
constePredicateType & type
Returns:
CRDFPredicate predicate
bool CRDFPredicate::operator== ( const CRDFPredicate rhs) const

Comparison operator for equality.

Parameters:
constCRDFPredicate & rhs
Returns:
bool isEqual
void CRDFPredicate::setURI ( const std::string &  uri)

Set the URI.

Parameters:
conststd::string & URI

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os,
const CRDFPredicate p 
) [friend]

Friend declaration of ostream operator

Parameters:
std::ostream& os
constCRDFPredicate & p
Returns:
std::ostream & os

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines