9 |
* to be informed about the most important stuff it |
* to be informed about the most important stuff it |
10 |
* has to do. |
* has to do. |
11 |
* |
* |
|
* |
|
12 |
* @author Andreas Motl <andreas.motl@ilo.de> |
* @author Andreas Motl <andreas.motl@ilo.de> |
13 |
* @package org.netfrag.glib |
* @package org.netfrag.glib |
14 |
* @module DataSource::Locator |
* @name DataSource::Locator |
15 |
|
* @filesource |
16 |
* |
* |
17 |
*/ |
* |
18 |
|
* <b>Cvs-Log:</b> |
19 |
/** |
* |
20 |
|
* <pre> |
21 |
* $Id$ |
* $Id$ |
22 |
* |
* |
23 |
* $Log$ |
* $Log$ |
24 |
|
* Revision 1.7 2003/03/05 17:13:16 joko |
25 |
|
* updated docu (phpDocumentor testing....) |
26 |
|
* |
27 |
* Revision 1.6 2003/03/05 16:10:08 joko |
* Revision 1.6 2003/03/05 16:10:08 joko |
28 |
* updated docu (phpDocumentor testing....) |
* updated docu (phpDocumentor testing....) |
29 |
* |
* |
41 |
* |
* |
42 |
* Revision 1.1 2003/03/05 12:04:37 joko |
* Revision 1.1 2003/03/05 12:04:37 joko |
43 |
* + initial commit |
* + initial commit |
44 |
|
* </pre> |
45 |
* |
* |
46 |
* |
* |
47 |
*/ |
*/ |
49 |
/** |
/** |
50 |
* It helps DataSource::Generic working in different "operation modes". |
* It helps DataSource::Generic working in different "operation modes". |
51 |
* |
* |
52 |
* - Pass-Through-Reference: php Object will get passed through all layers |
* <ul> |
53 |
* - Pass-Through-Memory: reference to a memory area will get used |
* o Pass-Through-Reference: php Object will get passed through all layers |
54 |
* + Build-Locator: build locator from datasource-type and adapter-type |
* o Pass-Through-Memory: reference to a memory area will get used |
55 |
* - Use-Locator: directly use DataSource::Locator instance passed in |
* x Build-Locator: build locator from datasource-type and adapter-type |
56 |
* - Merge-Locators: merge metadata of two or more DataSource::Locator instances |
* o Use-Locator: directly use DataSource::Locator instance passed in |
57 |
* - Build-AutoLocator: use global constants making up our metadata |
* o Merge-Locators: merge metadata of two or more DataSource::Locator instances |
58 |
|
* o Build-AutoLocator: use global constants making up our metadata |
59 |
|
* </ul> |
60 |
* |
* |
|
* <b>It can/should contain:</b> |
|
61 |
* |
* |
62 |
* <pre> |
* <b>It can/should contain:</b> |
63 |
* (flexible, just some parameters are required for each operation mode) |
* (flexible, just some parameters are required for each operation mode) |
64 |
* - an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR) |
* <ul> |
65 |
* + name of a Proxy module to use to *wrap/hide* the connection/transport-layer |
* o an oldschool "dsn"-string (e.g. for rdbms-connection via PEAR) |
66 |
|
* x name of a Proxy module to use to *wrap/hide* the connection/transport-layer |
67 |
* (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy) |
* (e.g. DataSource::Proxy::XMLRPC via DesignPattern::RemoteProxy) |
68 |
* + metadata (a hash) directly describing *where* to connect to (e.g. 'Host', 'Port') |
* x metadata (a hash) directly describing *where* to connect to (e.g. 'Host', 'Port') |
69 |
* - an instance of an already instantiated arbitrary datasource handler (e.g. 'source') |
* o an instance of an already instantiated arbitrary datasource handler (e.g. 'source') |
70 |
* this will get propagated (pass-through-mode) |
* this will get propagated (pass-through-mode) |
71 |
* - a datasource-type (of 'rpc|mysql|csv-file|xml-file') |
* o a datasource-type (of 'rpc|mysql|csv-file|xml-file') |
72 |
* this will be mapped to a module name and used as a *Proxy* |
* this will be mapped to a module name and used as a *Proxy* |
73 |
* by the DataSource::Generic at runtime |
* by the DataSource::Generic at runtime |
74 |
* + an adapter-type (of 'phpHtmlLib|pear') |
* x an adapter-type (of 'phpHtmlLib|pear') |
75 |
* this will be mapped to a module name and used as an *Adapter* |
* this will be mapped to a module name and used as an *Adapter* |
76 |
* by the DataSource::Generic at runtime |
* by the DataSource::Generic at runtime |
77 |
* - names of global constants where to find these informations |
* o names of global constants where to find these informations |
78 |
* - datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms') |
* o datasource-type ('rpc|csv-file|...') <-> datasource-family ('orm|rdbms|odbms') |
79 |
* </pre> |
* </ul> |
80 |
* |
* |
81 |
* |
* |
82 |
* <b>It can do</b> |
* <b>It can do</b> |
83 |
* + builds a larger locator from a minimum of information passed in via constructor-arguments |
* <ul> |
84 |
|
* # builds a larger locator from a minimum of information passed in via constructor-arguments |
85 |
* o direct fallback mode to some predefined constant names if locator is empty and above method fails |
* o direct fallback mode to some predefined constant names if locator is empty and above method fails |
86 |
* o direct fallback mode to some predefined values if just *everything* fails |
* o direct fallback mode to some predefined values if just *everything* fails |
87 |
|
* </ul> |
88 |
* |
* |
89 |
* |
* |
90 |
* <b>How to use?</b> |
* <b>How to use?</b> |
123 |
* @license GNU LGPL (GNU Lesser General Public License) |
* @license GNU LGPL (GNU Lesser General Public License) |
124 |
* @link http://www.gnu.org/licenses/lgpl.txt |
* @link http://www.gnu.org/licenses/lgpl.txt |
125 |
* |
* |
126 |
|
* @package org.netfrag.glib |
127 |
|
* @subpackage DataSource |
128 |
* @name DataSource::Locator |
* @name DataSource::Locator |
|
* @filesource |
|
129 |
* |
* |
130 |
*/ |
*/ |
|
|
|
|
|
|
131 |
class DataSource_Locator { |
class DataSource_Locator { |
132 |
|
|
133 |
/** |
/** |