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/classIsisConnector.tex | 128 +++++++++++++++++++++++++++++++++------ 1 file changed, 110 insertions(+), 18 deletions(-) (limited to 'doc/latex/classIsisConnector.tex') diff --git a/doc/latex/classIsisConnector.tex b/doc/latex/classIsisConnector.tex index e090fb8..0a72fe5 100644 --- a/doc/latex/classIsisConnector.tex +++ b/doc/latex/classIsisConnector.tex @@ -5,7 +5,7 @@ Inheritance diagram for IsisConnector:\begin{figure}[H] \begin{center} \leavevmode -\includegraphics[height=5cm]{classIsisConnector} +\includegraphics[height=5.000000cm]{classIsisConnector} \end{center} \end{figure} \subsection*{Public Member Functions} @@ -54,7 +54,12 @@ Inheritance diagram for IsisConnector:\begin{figure}[H] \hypertarget{classIsisConnector_a10669b49c4145a86dc3662c77733d74d}{ \index{IsisConnector@{IsisConnector}!existingItemKeys@{existingItemKeys}} \index{existingItemKeys@{existingItemKeys}!IsisConnector@{IsisConnector}} -\subsubsection[{existingItemKeys}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::existingItemKeys (\$ {\em field}, \/ \$ {\em row} = {\ttfamily 0})}} +\subsubsection[{existingItemKeys}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::existingItemKeys ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ row = {\ttfamily 0}} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_a10669b49c4145a86dc3662c77733d74d} Return the existing key items for a result. @@ -69,7 +74,13 @@ Array with existing item keys \hypertarget{classIsisConnector_acfea4d86a683cc7455d258cdb80db478}{ \index{IsisConnector@{IsisConnector}!explodeItem@{explodeItem}} \index{explodeItem@{explodeItem}!IsisConnector@{IsisConnector}} -\subsubsection[{explodeItem}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::explodeItem (\$ {\em field}, \/ \$ {\em item}, \/ \$ {\em row})}} +\subsubsection[{explodeItem}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::explodeItem ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ item, } +\item[{\$}]{ row} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_acfea4d86a683cc7455d258cdb80db478} Explode brackets for a given item, avoiding null entries. @@ -82,7 +93,13 @@ Exploded item data. \hypertarget{classIsisConnector_afc97554b42b8b9e98f396811bbfa13d8}{ \index{IsisConnector@{IsisConnector}!explodeSubfield@{explodeSubfield}} \index{explodeSubfield@{explodeSubfield}!IsisConnector@{IsisConnector}} -\subsubsection[{explodeSubfield}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::explodeSubfield (\$ {\em field}, \/ \$ {\em subfield}, \/ \$ {\em row})}} +\subsubsection[{explodeSubfield}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::explodeSubfield ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ subfield, } +\item[{\$}]{ row} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_afc97554b42b8b9e98f396811bbfa13d8} Explode brackets for a given subfield, avoiding null entries. @@ -95,7 +112,13 @@ Exploded subfield data. \hypertarget{classIsisConnector_a8baad24b6abc2ef29d8968f353ea6dae}{ \index{IsisConnector@{IsisConnector}!filterSubfield@{filterSubfield}} \index{filterSubfield@{filterSubfield}!IsisConnector@{IsisConnector}} -\subsubsection[{filterSubfield}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::filterSubfield (\$ {\em field}, \/ \$ {\em subfield}, \/ \$ {\em row})}} +\subsubsection[{filterSubfield}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::filterSubfield ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ subfield, } +\item[{\$}]{ row} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_a8baad24b6abc2ef29d8968f353ea6dae} Filter brackets for a given subfield. @@ -108,7 +131,13 @@ Filterd subfield data. \hypertarget{classIsisConnector_aa16bb24a54837048eee6244957cbf091}{ \index{IsisConnector@{IsisConnector}!getItem@{getItem}} \index{getItem@{getItem}!IsisConnector@{IsisConnector}} -\subsubsection[{getItem}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::getItem (\$ {\em field}, \/ \$ {\em item}, \/ \$ {\em row} = {\ttfamily 0})}} +\subsubsection[{getItem}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::getItem ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ item, } +\item[{\$}]{ row = {\ttfamily 0}} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_aa16bb24a54837048eee6244957cbf091} Get both main field or subfields from a given field and row. @@ -121,7 +150,12 @@ Item data. \hypertarget{classIsisConnector_aa928456a26e0264bf0c1a4869a02cbb3}{ \index{IsisConnector@{IsisConnector}!getItems@{getItems}} \index{getItems@{getItems}!IsisConnector@{IsisConnector}} -\subsubsection[{getItems}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::getItems (\$ {\em field}, \/ \$ {\em item})}} +\subsubsection[{getItems}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::getItems ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ item} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_aa928456a26e0264bf0c1a4869a02cbb3} Get all rows both main field or subfields from a given field. @@ -134,7 +168,12 @@ Item data. \hypertarget{classIsisConnector_a21c7c4e9fec2440f8c7d36f8a632c8c2}{ \index{IsisConnector@{IsisConnector}!getMainItem@{getMainItem}} \index{getMainItem@{getMainItem}!IsisConnector@{IsisConnector}} -\subsubsection[{getMainItem}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::getMainItem (\$ {\em field}, \/ \$ {\em row} = {\ttfamily 0})}} +\subsubsection[{getMainItem}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::getMainItem ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ row = {\ttfamily 0}} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_a21c7c4e9fec2440f8c7d36f8a632c8c2} Get the value of a given field. @@ -147,7 +186,11 @@ Field data. \hypertarget{classIsisConnector_a2bace7162ec3bf49df9f7acd9367c360}{ \index{IsisConnector@{IsisConnector}!getMainItems@{getMainItems}} \index{getMainItems@{getMainItems}!IsisConnector@{IsisConnector}} -\subsubsection[{getMainItems}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::getMainItems (\$ {\em field})}} +\subsubsection[{getMainItems}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::getMainItems ( +\begin{DoxyParamCaption} +\item[{\$}]{ field} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_a2bace7162ec3bf49df9f7acd9367c360} Get all values of a given field. @@ -160,7 +203,11 @@ Field data. \hypertarget{classIsisConnector_a0d1ebc176fe54568044aae02d7932c9b}{ \index{IsisConnector@{IsisConnector}!getRows@{getRows}} \index{getRows@{getRows}!IsisConnector@{IsisConnector}} -\subsubsection[{getRows}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::getRows (\$ {\em field})}} +\subsubsection[{getRows}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::getRows ( +\begin{DoxyParamCaption} +\item[{\$}]{ field} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_a0d1ebc176fe54568044aae02d7932c9b} Get the number of resulting rows for a given field. @@ -173,7 +220,13 @@ Number of rows. \hypertarget{classIsisConnector_a1ddaff24266ee02d652de9a752c1be8e}{ \index{IsisConnector@{IsisConnector}!getSubfield@{getSubfield}} \index{getSubfield@{getSubfield}!IsisConnector@{IsisConnector}} -\subsubsection[{getSubfield}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::getSubfield (\$ {\em field}, \/ \$ {\em subfield}, \/ \$ {\em row} = {\ttfamily 0})}} +\subsubsection[{getSubfield}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::getSubfield ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ subfield, } +\item[{\$}]{ row = {\ttfamily 0}} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_a1ddaff24266ee02d652de9a752c1be8e} Get the value of a given subfield. @@ -186,7 +239,12 @@ Subfield data. \hypertarget{classIsisConnector_ad8af0f5cef3b139649d9fb317264df10}{ \index{IsisConnector@{IsisConnector}!getSubfields@{getSubfields}} \index{getSubfields@{getSubfields}!IsisConnector@{IsisConnector}} -\subsubsection[{getSubfields}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::getSubfields (\$ {\em field}, \/ \$ {\em subfield})}} +\subsubsection[{getSubfields}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::getSubfields ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ subfield} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_ad8af0f5cef3b139649d9fb317264df10} Get all values of a given subfield. @@ -199,7 +257,11 @@ Subfield data. \hypertarget{classIsisConnector_ad806dcc5be703fe9aea63d72d68af0a2}{ \index{IsisConnector@{IsisConnector}!getValues@{getValues}} \index{getValues@{getValues}!IsisConnector@{IsisConnector}} -\subsubsection[{getValues}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::getValues (\$ {\em field})}} +\subsubsection[{getValues}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::getValues ( +\begin{DoxyParamCaption} +\item[{\$}]{ field} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_ad806dcc5be703fe9aea63d72d68af0a2} Get all values of a given field. @@ -212,7 +274,14 @@ Field data. \hypertarget{classIsisConnector_afbcef48a723b073a2777d5a5ed73d280}{ \index{IsisConnector@{IsisConnector}!hasFieldSubfieldCondition@{hasFieldSubfieldCondition}} \index{hasFieldSubfieldCondition@{hasFieldSubfieldCondition}!IsisConnector@{IsisConnector}} -\subsubsection[{hasFieldSubfieldCondition}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::hasFieldSubfieldCondition (\$ {\em field}, \/ \$ {\em subfield}, \/ \$ {\em key}, \/ \$ {\em subkey})}} +\subsubsection[{hasFieldSubfieldCondition}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::hasFieldSubfieldCondition ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ subfield, } +\item[{\$}]{ key, } +\item[{\$}]{ subkey} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_afbcef48a723b073a2777d5a5ed73d280} Check if a field and subfield match a given condition. @@ -225,7 +294,13 @@ True if condition match, false otherwise. \hypertarget{classIsisConnector_ad88ed9012aac0687aef1c8554879cd52}{ \index{IsisConnector@{IsisConnector}!hasItem@{hasItem}} \index{hasItem@{hasItem}!IsisConnector@{IsisConnector}} -\subsubsection[{hasItem}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::hasItem (\$ {\em field}, \/ \$ {\em item}, \/ \$ {\em row} = {\ttfamily 0})}} +\subsubsection[{hasItem}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::hasItem ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ item, } +\item[{\$}]{ row = {\ttfamily 0}} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_ad88ed9012aac0687aef1c8554879cd52} Check if a field result has an item. @@ -238,7 +313,12 @@ True if result has the main item, false otherwise. \hypertarget{classIsisConnector_a7bc914f2aa6c523404f368dc0b7b130b}{ \index{IsisConnector@{IsisConnector}!hasMainItem@{hasMainItem}} \index{hasMainItem@{hasMainItem}!IsisConnector@{IsisConnector}} -\subsubsection[{hasMainItem}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::hasMainItem (\$ {\em field}, \/ \$ {\em row})}} +\subsubsection[{hasMainItem}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::hasMainItem ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ row} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_a7bc914f2aa6c523404f368dc0b7b130b} Check if a field result has a main item. @@ -251,7 +331,13 @@ True if result has the main item, false otherwise. \hypertarget{classIsisConnector_a2e6970a3aca76a1dbb5b4bb5ac3adda1}{ \index{IsisConnector@{IsisConnector}!hasSubfield@{hasSubfield}} \index{hasSubfield@{hasSubfield}!IsisConnector@{IsisConnector}} -\subsubsection[{hasSubfield}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::hasSubfield (\$ {\em field}, \/ \$ {\em subfield}, \/ \$ {\em row})}} +\subsubsection[{hasSubfield}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::hasSubfield ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ subfield, } +\item[{\$}]{ row} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_a2e6970a3aca76a1dbb5b4bb5ac3adda1} Check if a field result and row has a given subfield. @@ -264,7 +350,13 @@ True if result has the subfield, false otherwise. \hypertarget{classIsisConnector_a9050227e8d8f10821a4df08a5705832a}{ \index{IsisConnector@{IsisConnector}!specialItem@{specialItem}} \index{specialItem@{specialItem}!IsisConnector@{IsisConnector}} -\subsubsection[{specialItem}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::specialItem (\$ {\em field}, \/ \$ {\em subfield}, \/ \$ {\em return} = {\ttfamily 'boolean'})}} +\subsubsection[{specialItem}]{\setlength{\rightskip}{0pt plus 5cm}IsisConnector::specialItem ( +\begin{DoxyParamCaption} +\item[{\$}]{ field, } +\item[{\$}]{ subfield, } +\item[{\$}]{ return = {\ttfamily 'boolean'}} +\end{DoxyParamCaption} +)}} \label{classIsisConnector_a9050227e8d8f10821a4df08a5705832a} Deal with special items. -- cgit v1.2.3