From b879f0fcc8651b49ae46a6db64d7eb1a27c7af1a Mon Sep 17 00:00:00 2001 From: Silvio Date: Fri, 20 Aug 2010 15:39:56 -0300 Subject: Adding generated docs --- doc/html/classIsisMap.html | 551 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 551 insertions(+) create mode 100644 doc/html/classIsisMap.html (limited to 'doc/html/classIsisMap.html') diff --git a/doc/html/classIsisMap.html b/doc/html/classIsisMap.html new file mode 100644 index 0000000..c2215f1 --- /dev/null +++ b/doc/html/classIsisMap.html @@ -0,0 +1,551 @@ + + + + + +Cinisis Database Reader: IsisMap Class Reference + + + + + + + + + +
+

IsisMap Class Reference

+Inheritance diagram for IsisMap:
+
+
+ + +IsisReader +IsisConnector +IsisFinder +IsisAudit + +
+
+ +

List of all members.

+ + + + + + + + + + + + + + + + + + +

Public Member Functions

 getMainItemName ($field)
 getSubfieldList ($field)
 getMap ($field, $subfield=NULL)
 getMapType ($field)
 fieldHasMap ($field)
 subfieldHasMap ($field, $subfield)
 getSubfieldKey ($field, $subfield)
 getItemKey ($field, $item)
 getFieldKey ($field)
 getFieldArray ($field_key)
 getSubfieldName ($field_key, $subfield_key)
 getFieldName ($field_key)

Static Public Member Functions

static methodName ($type)
static normalizeFieldName ($name)
static mapName ($name)
+

Detailed Description

+

Provides mappings and schema functionalities around Cinisis.

+

Member Function Documentation

+ +
+
+ + + + + + + + + +
IsisMap::fieldHasMap ($  field ) 
+
+
+

Check on an ISIS schema whether a field has a map.

+
Parameters:
+ + +
$field Field array.
+
+
+
Returns:
TRUE if field has a map, FALSE otherwise.
+ +
+
+ +
+
+ + + + + + + + + +
IsisMap::getFieldArray ($  field_key ) 
+
+
+

Get the array which defines a field.

+
Parameters:
+ + +
$field_key Field key.
+
+
+
Returns:
Field array.
+ +
+
+ +
+
+ + + + + + + + + +
IsisMap::getFieldKey ($  field ) 
+
+
+

Get the key of a field entry.

+
Parameters:
+ + +
$field Field array.
+
+
+
Returns:
Field key.
+ +
+
+ +
+
+ + + + + + + + + +
IsisMap::getFieldName ($  field_key ) 
+
+
+

Get a field name.

+
Parameters:
+ + +
$field_key Field key.
+
+
+
Returns:
Field name.
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
IsisMap::getItemKey ($  field,
$  item 
)
+
+
+

Get the item key.

+
Parameters:
+ + + +
$field Field array.
$item Item name.
+
+
+
Returns:
Item key.
+ +
+
+ +
+
+ + + + + + + + + +
IsisMap::getMainItemName ($  field ) 
+
+
+

Get the main field name.

+
Parameters:
+ + +
$field Field data from ISIS database schema.
+
+
+
Returns:
Main field name.
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
IsisMap::getMap ($  field,
$  subfield = NULL 
)
+
+
+

Determine which model field an ISIS db field should be mapped to. When importing an ISIS database to another system, a mapping provided in the database schema can be used to put the originating entries (fields and subfields) in the right place at the destination database.

+

Map format:

+

map: type: relation

+

map: type: value field: dest subfields: a: dest b: dest

+

Examples:

+

map: type: Performer

+

map: type: value field: title subfields: a: subtitle

+
Parameters:
+ + + +
$field Field array.
$subfield Subfield name.
+
+
+
Returns:
A map destination to the field or subfield.
+ +
+
+ +
+
+ + + + + + + + + +
IsisMap::getMapType ($  field ) 
+
+
+

Get the mapping type of a given field.

+
Parameters:
+ + +
$field Field array.
+
+
+
Returns:
The mapping type.
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
IsisMap::getSubfieldKey ($  field,
$  subfield 
)
+
+
+

Get the key of a subfield entry.

+
Parameters:
+ + + +
$field Field array.
$subfield Subfield name.
+
+
+
Returns:
Subfield key.
+ +
+
+ +
+
+ + + + + + + + + +
IsisMap::getSubfieldList ($  field ) 
+
+
+

Get the list of subfields from a given field.

+
Parameters:
+ + +
$field Field array.
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
IsisMap::getSubfieldName ($  field_key,
$  subfield_key 
)
+
+
+

Get a subfield name.

+
Parameters:
+ + + +
$field_key Field key.
$subfield_key Subfield key.
+
+
+
Returns:
Subfield name.
+ +
+
+ +
+
+ + + + + + + + + +
static IsisMap::mapName ($  name )  [static]
+
+
+

Build a map name.

+
Parameters:
+ + +
$name Field name
+
+
+
Returns:
Map name
+ +
+
+ +
+
+ + + + + + + + + +
static IsisMap::methodName ($  type )  [static]
+
+
+

Guess a method name from a type.

+
Parameters:
+ + +
$type Mapping type.
+
+
+
Returns:
Method name.
+ +
+
+ +
+
+ + + + + + + + + +
static IsisMap::normalizeFieldName ($  name )  [static]
+
+
+

Normalize field names.

+
Parameters:
+ + +
$name Field name
+
+
+
Returns:
Normalized field name
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
IsisMap::subfieldHasMap ($  field,
$  subfield 
)
+
+
+

Check on an ISIS schema whether a subfield has a map.

+
Parameters:
+ + + +
$field Field array.
$subfield Subfield name.
+
+
+
Returns:
TRUE if subfield has a map, FALSE otherwise.
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+ All Classes Functions Variables
+ + +
+ +
+ +
Generated on Fri Aug 20 15:38:20 2010 for Cinisis Database Reader by  + +doxygen 1.6.3
+ + -- cgit v1.2.3