From f253764c93f49dcdfe01b9e3f4d2a1352406b8f1 Mon Sep 17 00:00:00 2001 From: Silvio Date: Tue, 22 Feb 2011 10:37:10 -0300 Subject: Documentation update --- doc/latex/classIsisMap.tex | 129 +++++++++++++++++++++++++++++++++++++-------- 1 file changed, 108 insertions(+), 21 deletions(-) (limited to 'doc/latex/classIsisMap.tex') diff --git a/doc/latex/classIsisMap.tex b/doc/latex/classIsisMap.tex index 9a72945..7f37d94 100644 --- a/doc/latex/classIsisMap.tex +++ b/doc/latex/classIsisMap.tex @@ -5,7 +5,7 @@ Inheritance diagram for IsisMap:\begin{figure}[H] \begin{center} \leavevmode -\includegraphics[height=5cm]{classIsisMap} +\includegraphics[height=5.000000cm]{classIsisMap} \end{center} \end{figure} \subsection*{Public Member Functions} @@ -63,7 +63,11 @@ Provides mappings and schema functionalities around \hyperlink{classCinisis}{Cin \hypertarget{classIsisMap_af94e1fc5d73a6272f04a60c0acaeb409}{ \index{IsisMap@{IsisMap}!fieldHasMap@{fieldHasMap}} \index{fieldHasMap@{fieldHasMap}!IsisMap@{IsisMap}} -\subsubsection[{fieldHasMap}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::fieldHasMap (\$ {\em field})}} +\subsubsection[{fieldHasMap}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::fieldHasMap ( +\begin{DoxyParamCaption} +\item[{\$}]{ field} +\end{DoxyParamCaption} +)}} \label{classIsisMap_af94e1fc5d73a6272f04a60c0acaeb409} Check on an ISIS schema whether a field has a map. @@ -76,7 +80,12 @@ TRUE if field has a map, FALSE otherwise. \hypertarget{classIsisMap_a64c7193dd61a21c1af3624152d31ee51}{ \index{IsisMap@{IsisMap}!getAttributes@{getAttributes}} \index{getAttributes@{getAttributes}!IsisMap@{IsisMap}} -\subsubsection[{getAttributes}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getAttributes (\$ {\em field}, \/ \$ {\em subfield} = {\ttfamily null})}} +\subsubsection[{getAttributes}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getAttributes ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ subfield = {\ttfamily null}} +\end{DoxyParamCaption} +)}} \label{classIsisMap_a64c7193dd61a21c1af3624152d31ee51} Get attributes based on field and subfield. @@ -89,7 +98,11 @@ Attributes. \hypertarget{classIsisMap_a57808b2ac5892d71308c629b6ae990ff}{ \index{IsisMap@{IsisMap}!getDeniedCombinations@{getDeniedCombinations}} \index{getDeniedCombinations@{getDeniedCombinations}!IsisMap@{IsisMap}} -\subsubsection[{getDeniedCombinations}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getDeniedCombinations (\$ {\em field})}} +\subsubsection[{getDeniedCombinations}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getDeniedCombinations ( +\begin{DoxyParamCaption} +\item[{\$}]{ field} +\end{DoxyParamCaption} +)}} \label{classIsisMap_a57808b2ac5892d71308c629b6ae990ff} Defines the denied field combinations. @@ -108,7 +121,11 @@ Sample denied combination. \hypertarget{classIsisMap_aee1953b6e46b1612c725b2da82414d14}{ \index{IsisMap@{IsisMap}!getFieldArray@{getFieldArray}} \index{getFieldArray@{getFieldArray}!IsisMap@{IsisMap}} -\subsubsection[{getFieldArray}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getFieldArray (\$ {\em field\_\-key})}} +\subsubsection[{getFieldArray}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getFieldArray ( +\begin{DoxyParamCaption} +\item[{\$}]{ field\_\-key} +\end{DoxyParamCaption} +)}} \label{classIsisMap_aee1953b6e46b1612c725b2da82414d14} Get the array which defines a field. @@ -121,7 +138,11 @@ Field array. \hypertarget{classIsisMap_ac6a4eed048ddfa62c76e6d813754af81}{ \index{IsisMap@{IsisMap}!getFieldKey@{getFieldKey}} \index{getFieldKey@{getFieldKey}!IsisMap@{IsisMap}} -\subsubsection[{getFieldKey}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getFieldKey (\$ {\em field})}} +\subsubsection[{getFieldKey}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getFieldKey ( +\begin{DoxyParamCaption} +\item[{\$}]{ field} +\end{DoxyParamCaption} +)}} \label{classIsisMap_ac6a4eed048ddfa62c76e6d813754af81} Get the key of a field entry. @@ -134,7 +155,11 @@ Field key. \hypertarget{classIsisMap_ae41313537e399f15ff16a4db887cf5b9}{ \index{IsisMap@{IsisMap}!getFieldName@{getFieldName}} \index{getFieldName@{getFieldName}!IsisMap@{IsisMap}} -\subsubsection[{getFieldName}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getFieldName (\$ {\em field\_\-key})}} +\subsubsection[{getFieldName}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getFieldName ( +\begin{DoxyParamCaption} +\item[{\$}]{ field\_\-key} +\end{DoxyParamCaption} +)}} \label{classIsisMap_ae41313537e399f15ff16a4db887cf5b9} Get a field name. @@ -147,7 +172,11 @@ Field name. \hypertarget{classIsisMap_a157fffbdb6c533a66e3f73674bfd8ea4}{ \index{IsisMap@{IsisMap}!getFieldNames@{getFieldNames}} \index{getFieldNames@{getFieldNames}!IsisMap@{IsisMap}} -\subsubsection[{getFieldNames}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getFieldNames ()}} +\subsubsection[{getFieldNames}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getFieldNames ( +\begin{DoxyParamCaption} +{} +\end{DoxyParamCaption} +)}} \label{classIsisMap_a157fffbdb6c533a66e3f73674bfd8ea4} Get all field names. @@ -157,7 +186,11 @@ Array with field names. \hypertarget{classIsisMap_a2ca9d83aad166eed936f6f9ef8df05e3}{ \index{IsisMap@{IsisMap}!getFullMap@{getFullMap}} \index{getFullMap@{getFullMap}!IsisMap@{IsisMap}} -\subsubsection[{getFullMap}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getFullMap (\$ {\em field})}} +\subsubsection[{getFullMap}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getFullMap ( +\begin{DoxyParamCaption} +\item[{\$}]{ field} +\end{DoxyParamCaption} +)}} \label{classIsisMap_a2ca9d83aad166eed936f6f9ef8df05e3} Get the full map. @@ -170,7 +203,12 @@ Array with full map or false if there is no map. \hypertarget{classIsisMap_a994934784caa4149737bda55160a459f}{ \index{IsisMap@{IsisMap}!getItemKey@{getItemKey}} \index{getItemKey@{getItemKey}!IsisMap@{IsisMap}} -\subsubsection[{getItemKey}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getItemKey (\$ {\em field}, \/ \$ {\em item})}} +\subsubsection[{getItemKey}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getItemKey ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ item} +\end{DoxyParamCaption} +)}} \label{classIsisMap_a994934784caa4149737bda55160a459f} Get the item key. @@ -183,7 +221,11 @@ Item key. \hypertarget{classIsisMap_af689f27e67b0b38a3e880ead17a487f5}{ \index{IsisMap@{IsisMap}!getMainItemName@{getMainItemName}} \index{getMainItemName@{getMainItemName}!IsisMap@{IsisMap}} -\subsubsection[{getMainItemName}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getMainItemName (\$ {\em field})}} +\subsubsection[{getMainItemName}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getMainItemName ( +\begin{DoxyParamCaption} +\item[{\$}]{ field} +\end{DoxyParamCaption} +)}} \label{classIsisMap_af689f27e67b0b38a3e880ead17a487f5} Get the main field name. @@ -196,7 +238,12 @@ Main field name. \hypertarget{classIsisMap_a29eb2c45b51f95fdfb9ff7af770ca6ce}{ \index{IsisMap@{IsisMap}!getMap@{getMap}} \index{getMap@{getMap}!IsisMap@{IsisMap}} -\subsubsection[{getMap}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getMap (\$ {\em field}, \/ \$ {\em subfield} = {\ttfamily NULL})}} +\subsubsection[{getMap}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getMap ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ subfield = {\ttfamily NULL}} +\end{DoxyParamCaption} +)}} \label{classIsisMap_a29eb2c45b51f95fdfb9ff7af770ca6ce} 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. @@ -221,7 +268,11 @@ A map destination to the field or subfield. \hypertarget{classIsisMap_a62b933be483fb6704e12e41f10286cd5}{ \index{IsisMap@{IsisMap}!getMapType@{getMapType}} \index{getMapType@{getMapType}!IsisMap@{IsisMap}} -\subsubsection[{getMapType}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getMapType (\$ {\em field})}} +\subsubsection[{getMapType}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getMapType ( +\begin{DoxyParamCaption} +\item[{\$}]{ field} +\end{DoxyParamCaption} +)}} \label{classIsisMap_a62b933be483fb6704e12e41f10286cd5} Get the mapping type of a given field. @@ -234,7 +285,12 @@ The mapping type. \hypertarget{classIsisMap_ae5d904b8407b38751656715fb9efd7cf}{ \index{IsisMap@{IsisMap}!getSubfieldKey@{getSubfieldKey}} \index{getSubfieldKey@{getSubfieldKey}!IsisMap@{IsisMap}} -\subsubsection[{getSubfieldKey}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getSubfieldKey (\$ {\em field}, \/ \$ {\em subfield})}} +\subsubsection[{getSubfieldKey}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getSubfieldKey ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ subfield} +\end{DoxyParamCaption} +)}} \label{classIsisMap_ae5d904b8407b38751656715fb9efd7cf} Get the key of a subfield entry. @@ -247,7 +303,11 @@ Subfield key. \hypertarget{classIsisMap_ad0b61ec2fbfb011db4bf89c5f54efab4}{ \index{IsisMap@{IsisMap}!getSubfieldList@{getSubfieldList}} \index{getSubfieldList@{getSubfieldList}!IsisMap@{IsisMap}} -\subsubsection[{getSubfieldList}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getSubfieldList (\$ {\em field})}} +\subsubsection[{getSubfieldList}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getSubfieldList ( +\begin{DoxyParamCaption} +\item[{\$}]{ field} +\end{DoxyParamCaption} +)}} \label{classIsisMap_ad0b61ec2fbfb011db4bf89c5f54efab4} Get the list of subfields from a given field. @@ -257,7 +317,13 @@ Get the list of subfields from a given field. \hypertarget{classIsisMap_a58d739ea1f014befdafef7035d46c074}{ \index{IsisMap@{IsisMap}!getSubfieldName@{getSubfieldName}} \index{getSubfieldName@{getSubfieldName}!IsisMap@{IsisMap}} -\subsubsection[{getSubfieldName}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getSubfieldName (\$ {\em field}, \/ \$ {\em subfield\_\-key}, \/ \$ {\em by\_\-key} = {\ttfamily FALSE})}} +\subsubsection[{getSubfieldName}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getSubfieldName ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ subfield\_\-key, } +\item[{\$}]{ by\_\-key = {\ttfamily FALSE}} +\end{DoxyParamCaption} +)}} \label{classIsisMap_a58d739ea1f014befdafef7035d46c074} Get a subfield name. @@ -270,7 +336,11 @@ Subfield name. \hypertarget{classIsisMap_a1f30d131831b036271b0a1ff6d5d9d68}{ \index{IsisMap@{IsisMap}!getSubfieldNames@{getSubfieldNames}} \index{getSubfieldNames@{getSubfieldNames}!IsisMap@{IsisMap}} -\subsubsection[{getSubfieldNames}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getSubfieldNames (\$ {\em field\_\-key})}} +\subsubsection[{getSubfieldNames}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getSubfieldNames ( +\begin{DoxyParamCaption} +\item[{\$}]{ field\_\-key} +\end{DoxyParamCaption} +)}} \label{classIsisMap_a1f30d131831b036271b0a1ff6d5d9d68} Get all subfield names. @@ -283,7 +353,11 @@ Array with subfield names. \hypertarget{classIsisMap_a7f1b9b1cce7a02dea704a40ca85e2117}{ \index{IsisMap@{IsisMap}!mapName@{mapName}} \index{mapName@{mapName}!IsisMap@{IsisMap}} -\subsubsection[{mapName}]{\setlength{\rightskip}{0pt plus 5cm}static IsisMap::mapName (\$ {\em name})\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} +\subsubsection[{mapName}]{\setlength{\rightskip}{0pt plus 5cm}static IsisMap::mapName ( +\begin{DoxyParamCaption} +\item[{\$}]{ name} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} \label{classIsisMap_a7f1b9b1cce7a02dea704a40ca85e2117} Build a map name. @@ -296,7 +370,11 @@ Map name \hypertarget{classIsisMap_af80aedabfeca623a9022dfcbc95d591c}{ \index{IsisMap@{IsisMap}!methodName@{methodName}} \index{methodName@{methodName}!IsisMap@{IsisMap}} -\subsubsection[{methodName}]{\setlength{\rightskip}{0pt plus 5cm}static IsisMap::methodName (\$ {\em type})\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} +\subsubsection[{methodName}]{\setlength{\rightskip}{0pt plus 5cm}static IsisMap::methodName ( +\begin{DoxyParamCaption} +\item[{\$}]{ type} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} \label{classIsisMap_af80aedabfeca623a9022dfcbc95d591c} Guess a method name from a type. @@ -309,7 +387,11 @@ Method name. \hypertarget{classIsisMap_ae2abf0591a4862f537fa23537ffca705}{ \index{IsisMap@{IsisMap}!normalizeFieldName@{normalizeFieldName}} \index{normalizeFieldName@{normalizeFieldName}!IsisMap@{IsisMap}} -\subsubsection[{normalizeFieldName}]{\setlength{\rightskip}{0pt plus 5cm}static IsisMap::normalizeFieldName (\$ {\em name})\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} +\subsubsection[{normalizeFieldName}]{\setlength{\rightskip}{0pt plus 5cm}static IsisMap::normalizeFieldName ( +\begin{DoxyParamCaption} +\item[{\$}]{ name} +\end{DoxyParamCaption} +)\hspace{0.3cm}{\ttfamily \mbox{[}static\mbox{]}}}} \label{classIsisMap_ae2abf0591a4862f537fa23537ffca705} Normalize field names. @@ -322,7 +404,12 @@ Normalized field name \hypertarget{classIsisMap_ab5493af644e529c11a3c3e6edc37c3b9}{ \index{IsisMap@{IsisMap}!subfieldHasMap@{subfieldHasMap}} \index{subfieldHasMap@{subfieldHasMap}!IsisMap@{IsisMap}} -\subsubsection[{subfieldHasMap}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::subfieldHasMap (\$ {\em field}, \/ \$ {\em subfield})}} +\subsubsection[{subfieldHasMap}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::subfieldHasMap ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ subfield} +\end{DoxyParamCaption} +)}} \label{classIsisMap_ab5493af644e529c11a3c3e6edc37c3b9} Check on an ISIS schema whether a subfield has a map. -- cgit v1.2.3