aboutsummaryrefslogtreecommitdiff
path: root/doc/latex
diff options
context:
space:
mode:
authorSilvio <silvio@devlet.com.br>2010-09-16 11:13:14 -0300
committerSilvio <silvio@devlet.com.br>2010-09-16 11:13:14 -0300
commit6857a6f1a08242ac3531f5e77c192b3c5a599ff3 (patch)
tree69dfb47c35d2df63908dd166a5355e9d91cb8c87 /doc/latex
parent21bd1c86b53d26645a8d6f36624cd6bfb0041f61 (diff)
downloadcinisis-6857a6f1a08242ac3531f5e77c192b3c5a599ff3.tar.gz
cinisis-6857a6f1a08242ac3531f5e77c192b3c5a599ff3.tar.bz2
Minor fix and doc update
Diffstat (limited to 'doc/latex')
-rw-r--r--doc/latex/classBiblioIsisDb.pdfbin4432 -> 4432 bytes
-rw-r--r--doc/latex/classIsisAudit.pdfbin5896 -> 5896 bytes
-rw-r--r--doc/latex/classIsisConnector.pdfbin5892 -> 5892 bytes
-rw-r--r--doc/latex/classIsisFinder.pdfbin5893 -> 5893 bytes
-rw-r--r--doc/latex/classIsisMap.pdfbin5892 -> 5892 bytes
-rw-r--r--doc/latex/classIsisMap.tex61
-rw-r--r--doc/latex/classIsisReader.pdfbin5892 -> 5892 bytes
-rw-r--r--doc/latex/classMaleteDb.pdfbin4661 -> 4661 bytes
-rw-r--r--doc/latex/classPhpIsisDb.pdfbin4491 -> 4491 bytes
-rw-r--r--doc/latex/doxygen.sty4
-rw-r--r--doc/latex/interfaceIsisDb.pdfbin5431 -> 5431 bytes
-rw-r--r--doc/latex/refman.tex2
12 files changed, 59 insertions, 8 deletions
diff --git a/doc/latex/classBiblioIsisDb.pdf b/doc/latex/classBiblioIsisDb.pdf
index 1d43cee..2abd6fc 100644
--- a/doc/latex/classBiblioIsisDb.pdf
+++ b/doc/latex/classBiblioIsisDb.pdf
Binary files differ
diff --git a/doc/latex/classIsisAudit.pdf b/doc/latex/classIsisAudit.pdf
index 7d5deee..a85c346 100644
--- a/doc/latex/classIsisAudit.pdf
+++ b/doc/latex/classIsisAudit.pdf
Binary files differ
diff --git a/doc/latex/classIsisConnector.pdf b/doc/latex/classIsisConnector.pdf
index 868fb4b..c15f8c6 100644
--- a/doc/latex/classIsisConnector.pdf
+++ b/doc/latex/classIsisConnector.pdf
Binary files differ
diff --git a/doc/latex/classIsisFinder.pdf b/doc/latex/classIsisFinder.pdf
index 6e1a22d..03ee2ce 100644
--- a/doc/latex/classIsisFinder.pdf
+++ b/doc/latex/classIsisFinder.pdf
Binary files differ
diff --git a/doc/latex/classIsisMap.pdf b/doc/latex/classIsisMap.pdf
index f6f9eef..6911942 100644
--- a/doc/latex/classIsisMap.pdf
+++ b/doc/latex/classIsisMap.pdf
Binary files differ
diff --git a/doc/latex/classIsisMap.tex b/doc/latex/classIsisMap.tex
index 3497d9c..9a72945 100644
--- a/doc/latex/classIsisMap.tex
+++ b/doc/latex/classIsisMap.tex
@@ -31,13 +31,19 @@ Inheritance diagram for IsisMap:\begin{figure}[H]
\item
\hyperlink{classIsisMap_aee1953b6e46b1612c725b2da82414d14}{getFieldArray} (\$field\_\-key)
\item
-\hyperlink{classIsisMap_a83ffdd84c385513a09e5ab523a44d6f2}{getSubfieldName} (\$field\_\-key, \$subfield\_\-key)
+\hyperlink{classIsisMap_a58d739ea1f014befdafef7035d46c074}{getSubfieldName} (\$field, \$subfield\_\-key, \$by\_\-key=FALSE)
\item
\hyperlink{classIsisMap_a1f30d131831b036271b0a1ff6d5d9d68}{getSubfieldNames} (\$field\_\-key)
\item
\hyperlink{classIsisMap_ae41313537e399f15ff16a4db887cf5b9}{getFieldName} (\$field\_\-key)
\item
\hyperlink{classIsisMap_a157fffbdb6c533a66e3f73674bfd8ea4}{getFieldNames} ()
+\item
+\hyperlink{classIsisMap_a2ca9d83aad166eed936f6f9ef8df05e3}{getFullMap} (\$field)
+\item
+\hyperlink{classIsisMap_a64c7193dd61a21c1af3624152d31ee51}{getAttributes} (\$field, \$subfield=null)
+\item
+\hyperlink{classIsisMap_a57808b2ac5892d71308c629b6ae990ff}{getDeniedCombinations} (\$field)
\end{DoxyCompactItemize}
\subsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
@@ -67,6 +73,38 @@ Check on an ISIS schema whether a field has a map.
\begin{DoxyReturn}{Returns}
TRUE if field has a map, FALSE otherwise.
\end{DoxyReturn}
+\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})}}
+\label{classIsisMap_a64c7193dd61a21c1af3624152d31ee51}
+Get attributes based on field and subfield.
+
+
+\begin{DoxyParams}{Parameters}
+\item[{\em \$field}]Field data from ISIS database schema.\item[{\em \$subfield}]Subfield name.\end{DoxyParams}
+\begin{DoxyReturn}{Returns}
+Attributes.
+\end{DoxyReturn}
+\hypertarget{classIsisMap_a57808b2ac5892d71308c629b6ae990ff}{
+\index{IsisMap@{IsisMap}!getDeniedCombinations@{getDeniedCombinations}}
+\index{getDeniedCombinations@{getDeniedCombinations}!IsisMap@{IsisMap}}
+\subsubsection[{getDeniedCombinations}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getDeniedCombinations (\$ {\em field})}}
+\label{classIsisMap_a57808b2ac5892d71308c629b6ae990ff}
+Defines the denied field combinations.
+
+
+\begin{DoxyParams}{Parameters}
+\item[{\em \$field}]Field data from ISIS database schema.\end{DoxyParams}
+\begin{DoxyReturn}{Returns}
+Denied field combinations.
+\end{DoxyReturn}
+
+
+Sample denied combination.
+
+\$sample = array( 0 =$>$ array('a', 'b', 'c'), // a AND b AND c OR 1 =$>$ array('a', 'c', '!d'), // a AND b BUT WITHOUT d OR 2 =$>$ array('a', 'b', '$\ast$'), // a AND b AND any other item OR 3 =$>$ array('$\ast$2'), // ANY two items together OR 4 =$>$ array('main', '$\ast$'), // main AND ANY other item OR );
+
\hypertarget{classIsisMap_aee1953b6e46b1612c725b2da82414d14}{
\index{IsisMap@{IsisMap}!getFieldArray@{getFieldArray}}
\index{getFieldArray@{getFieldArray}!IsisMap@{IsisMap}}
@@ -116,6 +154,19 @@ Get all field names.
\begin{DoxyReturn}{Returns}
Array with field names.
\end{DoxyReturn}
+\hypertarget{classIsisMap_a2ca9d83aad166eed936f6f9ef8df05e3}{
+\index{IsisMap@{IsisMap}!getFullMap@{getFullMap}}
+\index{getFullMap@{getFullMap}!IsisMap@{IsisMap}}
+\subsubsection[{getFullMap}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getFullMap (\$ {\em field})}}
+\label{classIsisMap_a2ca9d83aad166eed936f6f9ef8df05e3}
+Get the full map.
+
+
+\begin{DoxyParams}{Parameters}
+\item[{\em \$field}]Field key.\end{DoxyParams}
+\begin{DoxyReturn}{Returns}
+Array with full map or false if there is no map.
+\end{DoxyReturn}
\hypertarget{classIsisMap_a994934784caa4149737bda55160a459f}{
\index{IsisMap@{IsisMap}!getItemKey@{getItemKey}}
\index{getItemKey@{getItemKey}!IsisMap@{IsisMap}}
@@ -203,16 +254,16 @@ Get the list of subfields from a given field.
\begin{DoxyParams}{Parameters}
\item[{\em \$field}]Field array. \end{DoxyParams}
-\hypertarget{classIsisMap_a83ffdd84c385513a09e5ab523a44d6f2}{
+\hypertarget{classIsisMap_a58d739ea1f014befdafef7035d46c074}{
\index{IsisMap@{IsisMap}!getSubfieldName@{getSubfieldName}}
\index{getSubfieldName@{getSubfieldName}!IsisMap@{IsisMap}}
-\subsubsection[{getSubfieldName}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getSubfieldName (\$ {\em field\_\-key}, \/ \$ {\em subfield\_\-key})}}
-\label{classIsisMap_a83ffdd84c385513a09e5ab523a44d6f2}
+\subsubsection[{getSubfieldName}]{\setlength{\rightskip}{0pt plus 5cm}IsisMap::getSubfieldName (\$ {\em field}, \/ \$ {\em subfield\_\-key}, \/ \$ {\em by\_\-key} = {\ttfamily FALSE})}}
+\label{classIsisMap_a58d739ea1f014befdafef7035d46c074}
Get a subfield name.
\begin{DoxyParams}{Parameters}
-\item[{\em \$field\_\-key}]Field key.\item[{\em \$subfield\_\-key}]Subfield key.\end{DoxyParams}
+\item[{\em \$field}]Field name or key.\item[{\em \$subfield\_\-key}]Subfield key.\item[{\em \$by\_\-key}]Set to true if you're passing the field key instead of it's name.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Subfield name.
\end{DoxyReturn}
diff --git a/doc/latex/classIsisReader.pdf b/doc/latex/classIsisReader.pdf
index c3dd9d5..56a6a12 100644
--- a/doc/latex/classIsisReader.pdf
+++ b/doc/latex/classIsisReader.pdf
Binary files differ
diff --git a/doc/latex/classMaleteDb.pdf b/doc/latex/classMaleteDb.pdf
index 15e5ffc..74b8f07 100644
--- a/doc/latex/classMaleteDb.pdf
+++ b/doc/latex/classMaleteDb.pdf
Binary files differ
diff --git a/doc/latex/classPhpIsisDb.pdf b/doc/latex/classPhpIsisDb.pdf
index 0332652..2e815ad 100644
--- a/doc/latex/classPhpIsisDb.pdf
+++ b/doc/latex/classPhpIsisDb.pdf
Binary files differ
diff --git a/doc/latex/doxygen.sty b/doc/latex/doxygen.sty
index 67d6e92..b560067 100644
--- a/doc/latex/doxygen.sty
+++ b/doc/latex/doxygen.sty
@@ -27,9 +27,9 @@
\fancyplain{}{\bfseries\thepage}%
}
\rfoot[\fancyplain{}{\bfseries\scriptsize%
- Generated on Thu Sep 2 12:20:40 2010 for Cinisis Database Reader by Doxygen }]{}
+ Generated on Thu Sep 16 11:13:07 2010 for Cinisis Database Reader by Doxygen }]{}
\lfoot[]{\fancyplain{}{\bfseries\scriptsize%
- Generated on Thu Sep 2 12:20:40 2010 for Cinisis Database Reader by Doxygen }}
+ Generated on Thu Sep 16 11:13:07 2010 for Cinisis Database Reader by Doxygen }}
\cfoot{}
%---------- Internal commands used in this style file ----------------
diff --git a/doc/latex/interfaceIsisDb.pdf b/doc/latex/interfaceIsisDb.pdf
index a3def53..9c7404b 100644
--- a/doc/latex/interfaceIsisDb.pdf
+++ b/doc/latex/interfaceIsisDb.pdf
Binary files differ
diff --git a/doc/latex/refman.tex b/doc/latex/refman.tex
index 3b38bc4..9d45984 100644
--- a/doc/latex/refman.tex
+++ b/doc/latex/refman.tex
@@ -41,7 +41,7 @@
\vspace*{1cm}
{\large Generated by Doxygen 1.6.3}\\
\vspace*{0.5cm}
-{\small Thu Sep 2 12:20:40 2010}\\
+{\small Thu Sep 16 11:13:07 2010}\\
\end{center}
\end{titlepage}
\clearemptydoublepage