cdmlib-model/eu/etaxonomy/cdm/model/common/IParsable.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:38:51 CEST 2008 -->
   6 <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
   7 <TITLE>
   8 IParsable (CDM Domain Model 1.3 API)
   9 </TITLE>
  10
  11 <META NAME="keywords" CONTENT="eu.etaxonomy.cdm.model.common.IParsable 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="IParsable (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/IParsable.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/model/common/ILoadableTerm.html" title="interface in eu.etaxonomy.cdm.model.common"><B>PREV CLASS</B></A>&nbsp;
  57 &nbsp;<A HREF="../../../../../eu/etaxonomy/cdm/model/common/IReferencedEntity.html" title="interface in eu.etaxonomy.cdm.model.common"><B>NEXT CLASS</B></A></FONT></TD>
  58 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  59   <A HREF="../../../../../index.html?eu/etaxonomy/cdm/model/common/IParsable.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  60 &nbsp;<A HREF="IParsable.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.model.common</FONT>
  90 <BR>
  91 Interface IParsable</H2>
  92 <DL>
  93 <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../eu/etaxonomy/cdm/model/reference/Article.html" title="class in eu.etaxonomy.cdm.model.reference">Article</A>, <A HREF="../../../../../eu/etaxonomy/cdm/model/name/BacterialName.html" title="class in eu.etaxonomy.cdm.model.name">BacterialName</A>, <A HREF="../../../../../eu/etaxonomy/cdm/model/reference/BibtexReference.html" title="class in eu.etaxonomy.cdm.model.reference">BibtexReference</A>, <A HREF="../../../../../eu/etaxonomy/cdm/model/reference/Book.html" title="class in eu.etaxonomy.cdm.model.reference">Book</A>, <A HREF="../../../../../eu/etaxonomy/cdm/model/reference/BookSection.html" title="class in eu.etaxonomy.cdm.model.reference">BookSection</A>, <A HREF="../../../../../eu/etaxonomy/cdm/model/name/BotanicalName.html" title="class in eu.etaxonomy.cdm.model.name">BotanicalName</A>, <A HREF="../../../../../eu/etaxonomy/cdm/model/reference/CdDvd.html" title="class in eu.etaxonomy.cdm.model.reference">CdDvd</A>, <A HREF="../../../../../eu/etaxonomy/cdm/model/name/CultivarPlantName.html" title="class in eu.etaxonomy.cdm.model.name">CultivarPlantName</A>, <A HREF="../../../../../eu/etaxonomy/cdm/model/reference/Database.html" title="class in eu.etaxonomy.cdm.model.reference">Database</A>, <A HREF="../../../../../eu/etaxonomy/cdm/model/reference/Generic.html" title="class in eu.etaxonomy.cdm.model.reference">Generic</A>, <A HREF="../../../../../eu/etaxonomy/cdm/model/reference/InProceedings.html" title="class in eu.etaxonomy.cdm.model.reference">InProceedings</A>, <A HREF="../../../../../eu/etaxonomy/cdm/model/reference/Journal.html" title="class in eu.etaxonomy.cdm.model.reference">Journal</A>, <A HREF="../../../../../eu/etaxonomy/cdm/model/reference/Map.html" title="class in eu.etaxonomy.cdm.model.reference">Map</A>, <A HREF="../../../../../eu/etaxonomy/cdm/model/name/NonViralName.html" title="class in eu.etaxonomy.cdm.model.name">NonViralName</A>, <A HREF="../../../../../eu/etaxonomy/cdm/model/reference/Patent.html" title="class in eu.etaxonomy.cdm.model.reference">Patent</A>, <A HREF="../../../../../eu/etaxonomy/cdm/model/reference/PersonalCommunication.html" title="class in eu.etaxonomy.cdm.model.reference">PersonalCommunication</A>, <A HREF="../../../../../eu/etaxonomy/cdm/model/reference/PrintedUnitBase.html" title="class in eu.etaxonomy.cdm.model.reference">PrintedUnitBase</A>, <A HREF="../../../../../eu/etaxonomy/cdm/model/reference/PrintSeries.html" title="class in eu.etaxonomy.cdm.model.reference">PrintSeries</A>, <A HREF="../../../../../eu/etaxonomy/cdm/model/reference/Proceedings.html" title="class in eu.etaxonomy.cdm.model.reference">Proceedings</A>, <A HREF="../../../../../eu/etaxonomy/cdm/model/reference/PublicationBase.html" title="class in eu.etaxonomy.cdm.model.reference">PublicationBase</A>, <A HREF="../../../../../eu/etaxonomy/cdm/model/reference/ReferenceBase.html" title="class in eu.etaxonomy.cdm.model.reference">ReferenceBase</A>, <A HREF="../../../../../eu/etaxonomy/cdm/model/reference/Report.html" title="class in eu.etaxonomy.cdm.model.reference">Report</A>, <A HREF="../../../../../eu/etaxonomy/cdm/model/reference/SectionBase.html" title="class in eu.etaxonomy.cdm.model.reference">SectionBase</A>, <A HREF="../../../../../eu/etaxonomy/cdm/model/reference/StrictReferenceBase.html" title="class in eu.etaxonomy.cdm.model.reference">StrictReferenceBase</A>, <A HREF="../../../../../eu/etaxonomy/cdm/model/name/TaxonNameBase.html" title="class in eu.etaxonomy.cdm.model.name">TaxonNameBase</A>, <A HREF="../../../../../eu/etaxonomy/cdm/model/reference/Thesis.html" title="class in eu.etaxonomy.cdm.model.reference">Thesis</A>, <A HREF="../../../../../eu/etaxonomy/cdm/model/name/ViralName.html" title="class in eu.etaxonomy.cdm.model.name">ViralName</A>, <A HREF="../../../../../eu/etaxonomy/cdm/model/reference/WebPage.html" title="class in eu.etaxonomy.cdm.model.reference">WebPage</A>, <A HREF="../../../../../eu/etaxonomy/cdm/model/name/ZoologicalName.html" title="class in eu.etaxonomy.cdm.model.name">ZoologicalName</A></DD>
  94 </DL>
  95 <HR>
  96 <DL>
  97 <DT><PRE>public interface <B>IParsable</B></DL>
  98 </PRE>
  99
 100 <P>
 101 <DL>
 102 <DT><B>Version:</B></DT>
 103   <DD>1.0</DD>
 104 <DT><B>Author:</B></DT>
 105   <DD>a.mueller</DD>
 106 </DL>
 107 <HR>
 108
 109 <P>
 110
 111 <!-- ========== METHOD SUMMARY =========== -->
 112
 113 <A NAME="method_summary"><!-- --></A>
 114 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 115 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 116 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 117 <B>Method Summary</B></FONT></TH>
 118 </TR>
 119 <TR BGCOLOR="white" CLASS="TableRowColor">
 120 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 121 <CODE>&nbsp;boolean</CODE></FONT></TD>
 122 <TD><CODE><B><A HREF="../../../../../eu/etaxonomy/cdm/model/common/IParsable.html#getHasProblem()">getHasProblem</A></B>()</CODE>
 123
 124 <BR>
 125 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;this flag will be set to true if the parseName method was unable to successfully parse the name</TD>
 126 </TR>
 127 <TR BGCOLOR="white" CLASS="TableRowColor">
 128 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 129 <CODE>&nbsp;void</CODE></FONT></TD>
 130 <TD><CODE><B><A HREF="../../../../../eu/etaxonomy/cdm/model/common/IParsable.html#setHasProblem(boolean)">setHasProblem</A></B>(boolean&nbsp;hasProblem)</CODE>
 131
 132 <BR>
 133 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 134 </TR>
 135 </TABLE>
 136 &nbsp;
 137 <P>
 138
 139 <!-- ============ METHOD DETAIL ========== -->
 140
 141 <A NAME="method_detail"><!-- --></A>
 142 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 143 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 144 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 145 <B>Method Detail</B></FONT></TH>
 146 </TR>
 147 </TABLE>
 148
 149 <A NAME="getHasProblem()"><!-- --></A><H3>
 150 getHasProblem</H3>
 151 <PRE>
 152 boolean <B>getHasProblem</B>()</PRE>
 153 <DL>
 154 <DD>this flag will be set to true if the parseName method was unable to successfully parse the name
 155 <P>
 156 <DD><DL>
 157 </DL>
 158 </DD>
 159 </DL>
 160 <HR>
 161
 162 <A NAME="setHasProblem(boolean)"><!-- --></A><H3>
 163 setHasProblem</H3>
 164 <PRE>
 165 void <B>setHasProblem</B>(boolean&nbsp;hasProblem)</PRE>
 166 <DL>
 167 <DD><DL>
 168 </DL>
 169 </DD>
 170 </DL>
 171 <!-- ========= END OF CLASS DATA ========= -->
 172 <HR>
 173
 174
 175 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 176 <A NAME="navbar_bottom"><!-- --></A>
 177 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 178 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 179 <TR>
 180 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 181 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 182 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 183   <TR ALIGN="center" VALIGN="top">
 184   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 185   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 186   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 187   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/IParsable.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 188   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 189   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 190   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 191   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 192   </TR>
 193 </TABLE>
 194 </TD>
 195 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 196 </EM>
 197 </TD>
 198 </TR>
 199
 200 <TR>
 201 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 202 &nbsp;<A HREF="../../../../../eu/etaxonomy/cdm/model/common/ILoadableTerm.html" title="interface in eu.etaxonomy.cdm.model.common"><B>PREV CLASS</B></A>&nbsp;
 203 &nbsp;<A HREF="../../../../../eu/etaxonomy/cdm/model/common/IReferencedEntity.html" title="interface in eu.etaxonomy.cdm.model.common"><B>NEXT CLASS</B></A></FONT></TD>
 204 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 205   <A HREF="../../../../../index.html?eu/etaxonomy/cdm/model/common/IParsable.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 206 &nbsp;<A HREF="IParsable.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 207 &nbsp;<SCRIPT type="text/javascript">
 208   <!--
 209   if(window==top) {
 210     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
 211   }
 212   //-->
 213 </SCRIPT>
 214 <NOSCRIPT>
 215   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
 216 </NOSCRIPT>
 217
 218
 219 </FONT></TD>
 220 </TR>
 221 <TR>
 222 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 223   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 224 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 225 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 226 </TR>
 227 </TABLE>
 228 <A NAME="skip-navbar_bottom"></A>
 229 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 230
 231 <HR>
 232 Copyright &#169; 2008. All Rights Reserved.
 233 </BODY>
 234 </HTML>