Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

iopcDefines.h File Reference

Definition of constants that affect code generated by IOPC SP, DB schema generated by IOPC DBSC and so on. More...

#include "IopcMappingType.h"

Include dependency graph for iopcDefines.h:

Include dependency graph

This graph shows which files directly or indirectly include this file:

Included by dependency graph

Defines

#define PERSISTENT_OBJECTS_ANCESTOR   "IopcPersistentObject"
#define VARIABLE_NAME   "m_%s"
#define INDICATOR_VARIABLE_NAME   "m_%s_isValid"
#define GETTER_PREFIX   "get_"
#define SETTER_PREFIX   "set_"
#define METADATA_WRITER_TMP_FILE_NAME   "%s.iopc"
#define DEFAULT_METADATA_FILENAME   "%s_mapping.xml"
#define MAPPING_DTD_FILENAME   "mapping.dtd"
#define CLASS_ID_COLUMN_NAME   "CID"
#define OID_COLUMN_NAME   "OID"
#define PROJECT_MAIN_TABLE_NAME   "%s_MT"
#define PROJECT_MAIN_TABLE_CLASS_ID_INDEX_NAME   "%s_MT_CID_INDEX"
#define PROJECT_CLASS_IDS_TABLE_NAME   "%s_CIDS"
#define PROJECT_CLASS_IDS_CLASSNAME_COLUMN_NAME   "CLASS_NAME"
#define PROJECT_CLASS_IDS_CLASSNAME_MAX_LENGTH   64
#define PROJECT_CLASS_IDS_CLASSID_COLUMN_NAME   "CID"
#define POLYMORPHIC_VIEW_NAME   "%s_pv"
#define SIMPLE_VIEW_NAME   "%s_sv"
#define PRIMARY_KEY_CONSTRAINT_NAME   "%s_PK"
#define UNIQUE_CONSTRAINT_NAME   "%s_UN"
#define REFERENCES_CONSTRAINT_NAME   "%s_FK"
#define CASCADE_DELETE_CONSTRAINT_NAME   "%s_CD"
#define TABLE_CLASS_ID_INDEX_NAME   "%s_CID_INDEX"
#define DEFAULT_FETCH_GROUP   "default_fetch_group"
#define FIRST_PERSISTENT_GROUP   "1st_persistent_group"
#define FIRST_TRANSIENT_GROUP   "1st_transient_group"
#define DEFAULT_MAPPING_TYPE   IOPC_VERTICAL

Detailed Description

Definition of constants that affect code generated by IOPC SP, DB schema generated by IOPC DBSC and so on.

Author:
Josef Troch (josef.troch@email.cz)
Date:
2003 - 2004

Define Documentation

#define PERSISTENT_OBJECTS_ANCESTOR   "IopcPersistentObject"
 

Name of class whose descendants are treated as persistent capable.

#define VARIABLE_NAME   "m_%s"
 

Pattern that specifies how user specified names of persistent capable attributes will be changed if processing the source file by IOPC SP.

"%s" is the original user specified attribute name.

#define INDICATOR_VARIABLE_NAME   "m_%s_isValid"
 

Indicator variable name pattern for persistent capable attributes. Boolean variables of this name will be created if processing the source file by IOPC SP.

"%s" is the name of user specified persistent capable attribute.

#define GETTER_PREFIX   "get_"
 

Prefix of getter methods created by IOPC SP.

#define SETTER_PREFIX   "set_"
 

Prefix of setter methods created by IOPC SP.

#define METADATA_WRITER_TMP_FILE_NAME   "%s.iopc"
 

Pattern that specifies the name of temporary files created by XMLMetadataWriter

"%s" is the name of appropriate C++ source file (without extension).

#define DEFAULT_METADATA_FILENAME   "%s_mapping.xml"
 

If user doesn't specify the name of output XML file when generating the metadata by IOPC SP, the name is created using this pattern.

"%s" is the project name.

See also:
guessProjectName()

#define MAPPING_DTD_FILENAME   "mapping.dtd"
 

Name of file containing Document Type Definition for IOPC XML mapping files. The file is assumed to be in the same directory as iopc_dbsc.exe.

#define CLASS_ID_COLUMN_NAME   "CID"
 

Name of database table column to which objects' Class IDs are mapped.

#define OID_COLUMN_NAME   "OID"
 

Name of database table column to which objects' OIDs are mapped.

#define PROJECT_MAIN_TABLE_NAME   "%s_MT"
 

Pattern used to generate name of project's main table (i.e. the table that contains (OID, Class ID) pairs).

"%s" is the project name.

See also:
guessProjectName()

#define PROJECT_MAIN_TABLE_CLASS_ID_INDEX_NAME   "%s_MT_CID_INDEX"
 

Pattern used to generate name of index on Class ID column in project's main table.

"%s" is the project name.

See also:
guessProjectName()

#define PROJECT_CLASS_IDS_TABLE_NAME   "%s_CIDS"
 

Pattern used to generate name of project's Class ID table (i.e. the table that contains (Class name, Class ID) pairs).

"%s" is the project name.

See also:
guessProjectName()

#define PROJECT_CLASS_IDS_CLASSNAME_COLUMN_NAME   "CLASS_NAME"
 

Name of class name column in project's Class ID table.

#define PROJECT_CLASS_IDS_CLASSNAME_MAX_LENGTH   64
 

Maximum length of string in class name column in project's Class ID table.

#define PROJECT_CLASS_IDS_CLASSID_COLUMN_NAME   "CID"
 

Name of Class ID column in project's Class ID table.

#define POLYMORPHIC_VIEW_NAME   "%s_pv"
 

Pattern used to generate name of class's polymorphic view.

"%s" is name of the class.

#define SIMPLE_VIEW_NAME   "%s_sv"
 

Pattern used to generate name of class's simple view.

"%s" is name of the class.

#define PRIMARY_KEY_CONSTRAINT_NAME   "%s_PK"
 

Pattern used to generate name of table's primary key constraint.

"%s" is name of the table.

#define UNIQUE_CONSTRAINT_NAME   "%s_UN"
 

Pattern used to generate name of unique constraint on a table.

"%s" is name of the table (with some postfix if more unique constraints are used on some table).

#define REFERENCES_CONSTRAINT_NAME   "%s_FK"
 

Pattern used to generate references (foreign key) constraint on a table.

"%s" is name of the table (with some postfix if more references constraints are used on some table).

#define CASCADE_DELETE_CONSTRAINT_NAME   "%s_CD"
 

Pattern used to generate name of table's cascade delete constraint (ON DELETE CASCADE).

"%s" is name of the table.

#define TABLE_CLASS_ID_INDEX_NAME   "%s_CID_INDEX"
 

Pattern used to generate name of index on table's Class ID column.

"%s" is name of the table.

#define DEFAULT_FETCH_GROUP   "default_fetch_group"
 

Name of default fetch group - attribute group that is loaded automatically when accessing a persistent object.

By default this group contains all number type attributes.

#define FIRST_PERSISTENT_GROUP   "1st_persistent_group"
 

Name of persistent group that by default contains all non-number type persistent capable attributes (i.e. strings and wide strings).

#define FIRST_TRANSIENT_GROUP   "1st_transient_group"
 

Name of transient group that by default contain all non-persistent capable class attributes.

#define DEFAULT_MAPPING_TYPE   IOPC_VERTICAL
 

Default mapping type - mapping type that is used for IopcPersistentObject child if its mapping type hasn't been specified by user.

Generated on Wed Aug 11 22:33:58 2004 for IOPC by Doxygen 1.3.6