Project

General

Profile

« Previous | Next » 

Revision 9f8c2953

Added by Andreas Kohlbecker almost 7 years ago

ref #6719 updating documentation on the TypeDesignationConverter

View differences:

src/main/java/eu/etaxonomy/cdm/vaadin/util/converter/TypeDesignationConverter.java
38 38 
import eu.etaxonomy.cdm.vaadin.view.registration.RegistrationValidationException;
39 39 

  		




  40
  40
  
    
/**


  		




  41
  
  
    
 * Converts a collection of TypeDesignations, which should belong to the


  		




  42
  
  
    
 * same name of course, into a string representation.


  		




  
  41
  
    
 * Manages a collection of {@link TypeDesignationBase TypeDesignations} for the same same typified name.


  		




  
  42
  
    
 *


  		




  
  43
  
    
 * Type designations are ordered by the base type which is a {@link TaxonName} for {@link NameTypeDesignation NameTypeDesignations} or


  		




  
  44
  
    
 * in case of {@link SpecimenTypeDesignation SpecimenTypeDesignations} the  associate {@link FieldUnit} or the {@link DerivedUnit}


  		




  
  45
  
    
 * if the former is missing. The type designations per base type are furthermore ordered by the {@link TypeDesignationStatusBase}.


  		




  
  46
  
    
 *


  		




  
  47
  
    
 * The TypeDesignationConverter also provides string representations of the whole ordered set of all


  		




  
  48
  
    
 * {@link TypeDesignationBase TypeDesignations} and of the TypeDesignationWorkingSets:


  		




  
  49
  
    
 * <ul>


  		




  
  50
  
    
 *  <li>{@link #print()})


  		




  
  51
  
    
 *  <li>{@link #getOrderdTypeDesignationWorkingSets()} ... {@link TypeDesignationWorkingSet#getRepresentation()}


  		




  
  52
  
    
 * </ul>


  		




  
  53
  
    
 * Prior using the representations you need to trigger their generation by calling {@link #buildString()}


  		




  43
  54
  
    
 *


  		




  44
  
  
    
 * Order of TypeDesignations in the resulting string:


  		




  45
  
  
    
 *  Type, Holotype, Lectotype, Epitypes


  		




  46
  55
  
    
 * @author a.kohlbecker


  		




  47
  56
  
    
 * @since Mar 10, 2017


  		




  48
  57
  
    
 *


  		












Also available in:  Unified diff