cdmlib-model/eu/etaxonomy/cdm/strategy/cache/reference/INomenclaturalReferenceCacheStrategy.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <!--NewPage-->
   3 <HTML>
   4 <HEAD>
   5 <!-- Generated by javadoc (build 1.5.0_15) on Tue Aug 26 16:39:06 CEST 2008 -->
   6 <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
   7 <TITLE>
   8 INomenclaturalReferenceCacheStrategy (CDM Domain Model 1.3 API)
   9 </TITLE>
  10
  11 <META NAME="keywords" CONTENT="eu.etaxonomy.cdm.strategy.cache.reference.INomenclaturalReferenceCacheStrategy interface">
  12
  13 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
  14
  15 <SCRIPT type="text/javascript">
  16 function windowTitle()
  17 {
  18     parent.document.title="INomenclaturalReferenceCacheStrategy (CDM Domain Model 1.3 API)";
  19 }
  20 </SCRIPT>
  21 <NOSCRIPT>
  22 </NOSCRIPT>
  23
  24 </HEAD>
  25
  26 <BODY BGCOLOR="white" onload="windowTitle();">
  27
  28
  29 <!-- ========= START OF TOP NAVBAR ======= -->
  30 <A NAME="navbar_top"><!-- --></A>
  31 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  32 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  33 <TR>
  34 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  35 <A NAME="navbar_top_firstrow"><!-- --></A>
  36 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  37   <TR ALIGN="center" VALIGN="top">
  38   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  39   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  40   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/INomenclaturalReferenceCacheStrategy.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  42   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  46   </TR>
  47 </TABLE>
  48 </TD>
  49 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  50 </EM>
  51 </TD>
  52 </TR>
  53
  54 <TR>
  55 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  56 &nbsp;<A HREF="../../../../../../eu/etaxonomy/cdm/strategy/cache/reference/GenericDefaultCacheStrategy.html" title="class in eu.etaxonomy.cdm.strategy.cache.reference"><B>PREV CLASS</B></A>&nbsp;
  57 &nbsp;<A HREF="../../../../../../eu/etaxonomy/cdm/strategy/cache/reference/IReferenceBaseCacheStrategy.html" title="interface in eu.etaxonomy.cdm.strategy.cache.reference"><B>NEXT CLASS</B></A></FONT></TD>
  58 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  59   <A HREF="../../../../../../index.html?eu/etaxonomy/cdm/strategy/cache/reference/INomenclaturalReferenceCacheStrategy.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  60 &nbsp;<A HREF="INomenclaturalReferenceCacheStrategy.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  61 &nbsp;<SCRIPT type="text/javascript">
  62   <!--
  63   if(window==top) {
  64     document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  65   }
  66   //-->
  67 </SCRIPT>
  68 <NOSCRIPT>
  69   <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
  70 </NOSCRIPT>
  71
  72
  73 </FONT></TD>
  74 </TR>
  75 <TR>
  76 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  77   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  79 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  80 </TR>
  81 </TABLE>
  82 <A NAME="skip-navbar_top"></A>
  83 <!-- ========= END OF TOP NAVBAR ========= -->
  84
  85 <HR>
  86 <!-- ======== START OF CLASS DATA ======== -->
  87 <H2>
  88 <FONT SIZE="-1">
  89 eu.etaxonomy.cdm.strategy.cache.reference</FONT>
  90 <BR>
  91 Interface INomenclaturalReferenceCacheStrategy&lt;T extends <A HREF="../../../../../../eu/etaxonomy/cdm/model/reference/ReferenceBase.html" title="class in eu.etaxonomy.cdm.model.reference">ReferenceBase</A>&gt;</H2>
  92 <DL>
  93 <DT><DT><B>Type Parameters:</B><DD><CODE>T</CODE> - The concrete ReferenceBase class this strategy applies for</DL>
  94 <DL>
  95 <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../../../eu/etaxonomy/cdm/strategy/cache/common/IIdentifiableEntityCacheStrategy.html" title="interface in eu.etaxonomy.cdm.strategy.cache.common">IIdentifiableEntityCacheStrategy</A>&lt;T&gt;, <A HREF="../../../../../../eu/etaxonomy/cdm/strategy/cache/reference/IReferenceBaseCacheStrategy.html" title="interface in eu.etaxonomy.cdm.strategy.cache.reference">IReferenceBaseCacheStrategy</A>&lt;T&gt;, <A HREF="../../../../../../eu/etaxonomy/cdm/strategy/IStrategy.html" title="interface in eu.etaxonomy.cdm.strategy">IStrategy</A></DD>
  96 </DL>
  97 <DL>
  98 <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../../eu/etaxonomy/cdm/strategy/cache/reference/ArticleDefaultCacheStrategy.html" title="class in eu.etaxonomy.cdm.strategy.cache.reference">ArticleDefaultCacheStrategy</A>, <A HREF="../../../../../../eu/etaxonomy/cdm/strategy/cache/reference/BibtexDefaultCacheStrategy.html" title="class in eu.etaxonomy.cdm.strategy.cache.reference">BibtexDefaultCacheStrategy</A>, <A HREF="../../../../../../eu/etaxonomy/cdm/strategy/cache/reference/BookDefaultCacheStrategy.html" title="class in eu.etaxonomy.cdm.strategy.cache.reference">BookDefaultCacheStrategy</A>, <A HREF="../../../../../../eu/etaxonomy/cdm/strategy/cache/reference/BookSectionDefaultCacheStrategy.html" title="class in eu.etaxonomy.cdm.strategy.cache.reference">BookSectionDefaultCacheStrategy</A>, <A HREF="../../../../../../eu/etaxonomy/cdm/strategy/cache/reference/GenericDefaultCacheStrategy.html" title="class in eu.etaxonomy.cdm.strategy.cache.reference">GenericDefaultCacheStrategy</A>, <A HREF="../../../../../../eu/etaxonomy/cdm/strategy/cache/reference/NomRefDefaultCacheStrategyBase.html" title="class in eu.etaxonomy.cdm.strategy.cache.reference">NomRefDefaultCacheStrategyBase</A></DD>
  99 </DL>
 100 <HR>
 101 <DL>
 102 <DT><PRE>public interface <B>INomenclaturalReferenceCacheStrategy&lt;T extends <A HREF="../../../../../../eu/etaxonomy/cdm/model/reference/ReferenceBase.html" title="class in eu.etaxonomy.cdm.model.reference">ReferenceBase</A>&gt;</B><DT>extends <A HREF="../../../../../../eu/etaxonomy/cdm/strategy/cache/reference/IReferenceBaseCacheStrategy.html" title="interface in eu.etaxonomy.cdm.strategy.cache.reference">IReferenceBaseCacheStrategy</A>&lt;T&gt;</DL>
 103 </PRE>
 104
 105 <P>
 106 A reference cache rendering strategy for all subclasses implementing INomenclaturalReference.
 107 <P>
 108
 109 <P>
 110 <DL>
 111 <DT><B>Author:</B></DT>
 112   <DD>a.mueller</DD>
 113 </DL>
 114 <HR>
 115
 116 <P>
 117
 118 <!-- ========== METHOD SUMMARY =========== -->
 119
 120 <A NAME="method_summary"><!-- --></A>
 121 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 122 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 123 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 124 <B>Method Summary</B></FONT></TH>
 125 </TR>
 126 <TR BGCOLOR="white" CLASS="TableRowColor">
 127 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 128 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
 129 <TD><CODE><B><A HREF="../../../../../../eu/etaxonomy/cdm/strategy/cache/reference/INomenclaturalReferenceCacheStrategy.html#getBeforeMicroReference()">getBeforeMicroReference</A></B>()</CODE>
 130
 131 <BR>
 132 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the character sequence before the micro reference (e.g. ": ")</TD>
 133 </TR>
 134 <TR BGCOLOR="white" CLASS="TableRowColor">
 135 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 136 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
 137 <TD><CODE><B><A HREF="../../../../../../eu/etaxonomy/cdm/strategy/cache/reference/INomenclaturalReferenceCacheStrategy.html#getTitleCache(T)">getTitleCache</A></B>(<A HREF="../../../../../../eu/etaxonomy/cdm/strategy/cache/reference/INomenclaturalReferenceCacheStrategy.html" title="type parameter in INomenclaturalReferenceCacheStrategy">T</A>&nbsp;nomenclaturalReference)</CODE>
 138
 139 <BR>
 140 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;returns the composed scientific taxon name string without authors nor year</TD>
 141 </TR>
 142 <TR BGCOLOR="white" CLASS="TableRowColor">
 143 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 144 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
 145 <TD><CODE><B><A HREF="../../../../../../eu/etaxonomy/cdm/strategy/cache/reference/INomenclaturalReferenceCacheStrategy.html#getTokenizedNomenclaturalTitel(T)">getTokenizedNomenclaturalTitel</A></B>(<A HREF="../../../../../../eu/etaxonomy/cdm/strategy/cache/reference/INomenclaturalReferenceCacheStrategy.html" title="type parameter in INomenclaturalReferenceCacheStrategy">T</A>&nbsp;referenceBase)</CODE>
 146
 147 <BR>
 148 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;returns the composed author string</TD>
 149 </TR>
 150 </TABLE>
 151 &nbsp;
 152 <P>
 153
 154 <!-- ============ METHOD DETAIL ========== -->
 155
 156 <A NAME="method_detail"><!-- --></A>
 157 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 158 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 159 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 160 <B>Method Detail</B></FONT></TH>
 161 </TR>
 162 </TABLE>
 163
 164 <A NAME="getTitleCache(eu.etaxonomy.cdm.model.reference.ReferenceBase)"><!-- --></A><A NAME="getTitleCache(T)"><!-- --></A><H3>
 165 getTitleCache</H3>
 166 <PRE>
 167 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getTitleCache</B>(<A HREF="../../../../../../eu/etaxonomy/cdm/strategy/cache/reference/INomenclaturalReferenceCacheStrategy.html" title="type parameter in INomenclaturalReferenceCacheStrategy">T</A>&nbsp;nomenclaturalReference)</PRE>
 168 <DL>
 169 <DD>returns the composed scientific taxon name string without authors nor year
 170 <P>
 171 <DD><DL>
 172 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../eu/etaxonomy/cdm/strategy/cache/common/IIdentifiableEntityCacheStrategy.html#getTitleCache(T)">getTitleCache</A></CODE> in interface <CODE><A HREF="../../../../../../eu/etaxonomy/cdm/strategy/cache/common/IIdentifiableEntityCacheStrategy.html" title="interface in eu.etaxonomy.cdm.strategy.cache.common">IIdentifiableEntityCacheStrategy</A>&lt;<A HREF="../../../../../../eu/etaxonomy/cdm/strategy/cache/reference/INomenclaturalReferenceCacheStrategy.html" title="type parameter in INomenclaturalReferenceCacheStrategy">T</A> extends <A HREF="../../../../../../eu/etaxonomy/cdm/model/reference/ReferenceBase.html" title="class in eu.etaxonomy.cdm.model.reference">ReferenceBase</A>&gt;</CODE></DL>
 173 </DD>
 174 <DD><DL>
 175 <DT><B>Parameters:</B><DD><CODE>object</CODE> -
 176 <DT><B>Returns:</B><DD></DL>
 177 </DD>
 178 </DL>
 179 <HR>
 180
 181 <A NAME="getTokenizedNomenclaturalTitel(eu.etaxonomy.cdm.model.reference.ReferenceBase)"><!-- --></A><A NAME="getTokenizedNomenclaturalTitel(T)"><!-- --></A><H3>
 182 getTokenizedNomenclaturalTitel</H3>
 183 <PRE>
 184 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getTokenizedNomenclaturalTitel</B>(<A HREF="../../../../../../eu/etaxonomy/cdm/strategy/cache/reference/INomenclaturalReferenceCacheStrategy.html" title="type parameter in INomenclaturalReferenceCacheStrategy">T</A>&nbsp;referenceBase)</PRE>
 185 <DL>
 186 <DD>returns the composed author string
 187 <P>
 188 <DD><DL>
 189 </DL>
 190 </DD>
 191 <DD><DL>
 192 <DT><B>Parameters:</B><DD><CODE>object</CODE> -
 193 <DT><B>Returns:</B><DD></DL>
 194 </DD>
 195 </DL>
 196 <HR>
 197
 198 <A NAME="getBeforeMicroReference()"><!-- --></A><H3>
 199 getBeforeMicroReference</H3>
 200 <PRE>
 201 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getBeforeMicroReference</B>()</PRE>
 202 <DL>
 203 <DD>Returns the character sequence before the micro reference (e.g. ": ")
 204 <P>
 205 <DD><DL>
 206 </DL>
 207 </DD>
 208 <DD><DL>
 209
 210 <DT><B>Returns:</B><DD></DL>
 211 </DD>
 212 </DL>
 213 <!-- ========= END OF CLASS DATA ========= -->
 214 <HR>
 215
 216
 217 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 218 <A NAME="navbar_bottom"><!-- --></A>
 219 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 220 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 221 <TR>
 222 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 223 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 224 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 225   <TR ALIGN="center" VALIGN="top">
 226   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 227   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 228   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 229   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/INomenclaturalReferenceCacheStrategy.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 230   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 231   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 232   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 233   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 234   </TR>
 235 </TABLE>
 236 </TD>
 237 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 238 </EM>
 239 </TD>
 240 </TR>
 241
 242 <TR>
 243 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 244 &nbsp;<A HREF="../../../../../../eu/etaxonomy/cdm/strategy/cache/reference/GenericDefaultCacheStrategy.html" title="class in eu.etaxonomy.cdm.strategy.cache.reference"><B>PREV CLASS</B></A>&nbsp;
 245 &nbsp;<A HREF="../../../../../../eu/etaxonomy/cdm/strategy/cache/reference/IReferenceBaseCacheStrategy.html" title="interface in eu.etaxonomy.cdm.strategy.cache.reference"><B>NEXT CLASS</B></A></FONT></TD>
 246 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 247   <A HREF="../../../../../../index.html?eu/etaxonomy/cdm/strategy/cache/reference/INomenclaturalReferenceCacheStrategy.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 248 &nbsp;<A HREF="INomenclaturalReferenceCacheStrategy.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 249 &nbsp;<SCRIPT type="text/javascript">
 250   <!--
 251   if(window==top) {
 252     document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
 253   }
 254   //-->
 255 </SCRIPT>
 256 <NOSCRIPT>
 257   <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
 258 </NOSCRIPT>
 259
 260
 261 </FONT></TD>
 262 </TR>
 263 <TR>
 264 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 265   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 266 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 267 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 268 </TR>
 269 </TABLE>
 270 <A NAME="skip-navbar_bottom"></A>
 271 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 272
 273 <HR>
 274 Copyright &#169; 2008. All Rights Reserved.
 275 </BODY>
 276 </HTML>