Changeset 7432


Ignore:
Timestamp:
12/17/10 11:05:05 (9 years ago)
Author:
aivar
Message:

More javadoc.

Location:
branches/maven/projects/deep-zoom-plugin/src/main/java/loci/workflow
Files:
6 edited

Legend:

Unmodified
Added
Removed
  • branches/maven/projects/deep-zoom-plugin/src/main/java/loci/workflow/IComponentFactory.java

    r7430 r7432  
    88/** 
    99 * 
    10  * @author aivar 
     10 * @author Aivar Grislis 
    1111 */ 
    1212public interface IComponentFactory { 
  • branches/maven/projects/deep-zoom-plugin/src/main/java/loci/workflow/IOutputListener.java

    r7430 r7432  
    1717     * Tells listener that an output image is ready. 
    1818     * 
    19      * @param name 
     19     * @param name used for sharing listeners 
    2020     * @param image 
    2121     */ 
  • branches/maven/projects/deep-zoom-plugin/src/main/java/loci/workflow/WorkFlow.java

    r7431 r7432  
    1717 
    1818/** 
     19 * Builds a workflow consisting of chained components.  A component could also 
     20 * be another workflow.  Saves setup as XML file and restores from XML file. 
    1921 * 
    2022 * @author Aivar Grislis 
     
    482484 
    483485    /** 
    484      * Keeps track of a chained connection. 
     486     * Data structure that keeps track of a chained connection. 
    485487     */ 
    486488    private class Chain { 
     
    515517 
    516518    /** 
    517      * Keeps track of IComponent and name. 
     519     * Data structure that keeps track of IComponent and name. 
    518520     */ 
    519521    private class ComponentAndName { 
  • branches/maven/projects/deep-zoom-plugin/src/main/java/loci/workflow/XMLException.java

    r7430 r7432  
    88/** 
    99 * 
    10  * @author aivar 
     10 * @author Aivar Grislis 
    1111 */ 
    1212public class XMLException extends Exception { 
  • branches/maven/projects/deep-zoom-plugin/src/main/java/loci/workflow/XMLHelper.java

    r7430 r7432  
    99 
    1010/** 
     11 * XML Parser & Writer. 
    1112 * 
    12  * @author aivar 
     13 * @author Aivar Grislis 
    1314 */ 
    1415public class XMLHelper { 
    1516    StringBuilder m_string; 
    1617    int m_indent = 0; 
    17      
     18 
     19    /** 
     20     * Constructs a helper for parsing XML. 
     21     */ 
    1822    public XMLHelper() { 
    1923        m_string = null; 
    2024    } 
    21      
     25 
     26 
     27    /** 
     28     * Constructs a helper for writing to given 
     29     * string. 
     30     * 
     31     * @param string 
     32     */ 
    2233    public XMLHelper(StringBuilder string) { 
    2334        m_string = string; 
    2435    } 
    25      
     36 
     37    /** 
     38     * Parses the string and gets the tag data structure for the first tag. 
     39     * 
     40     * @param xml 
     41     * @return 
     42     * @throws XMLException 
     43     */ 
    2644    public XMLTag getNextTag(String xml) throws XMLException { 
    2745        return getTag(false, xml); 
    2846    } 
    29      
     47 
     48    /** 
     49     * Parses the string and gets the tag data structure for the first tag. 
     50     * This version includes the start and end tag in the content. 
     51     * 
     52     * @param xml 
     53     * @return 
     54     * @throws XMLException 
     55     */ 
    3056    public XMLTag getNextTagInclusive(String xml) throws XMLException { 
    3157        return getTag(true, xml); 
    3258    } 
    3359 
     60    /** 
     61     * Parses the string and gets the tag data structure for the first tag. 
     62     * 
     63     * @param inclusive 
     64     * @param xml 
     65     * @return 
     66     * @throws XMLException 
     67     */ 
    3468    private XMLTag getTag(boolean inclusive, String xml) throws XMLException { 
    3569        xml = xml.trim(); 
     
    68102    } 
    69103 
     104    /** 
     105     * For writing, starts a new tag. 
     106     * 
     107     * @param name 
     108     */ 
    70109    public void addTag(String name) { 
    71110        doIndent(); 
     
    77116    } 
    78117 
     118    /** 
     119     * For writing, ends a tag. 
     120     * 
     121     * @param name 
     122     */ 
    79123    public void addEndTag(String name) { 
    80124        --m_indent; 
     
    87131    } 
    88132 
     133    /** 
     134     * Adds a tag with some content on a single line. 
     135     * 
     136     * @param name 
     137     * @param content 
     138     */ 
    89139    public void addTagWithContent(String name, String content) { 
    90140        doIndent(); 
     
    100150    } 
    101151 
     152    /** 
     153     * Adds an embedded XML string with proper indent. 
     154     * 
     155     * @param output 
     156     */ 
    102157    public void add(String output) { 
    103158        String lines[] = output.split("\n"); 
     
    109164    } 
    110165 
     166    /** 
     167     * Does indentation. 
     168     */ 
    111169    private void doIndent() { 
    112170        for (int i = 0; i < 2 * m_indent; ++i) { 
  • branches/maven/projects/deep-zoom-plugin/src/main/java/loci/workflow/XMLTag.java

    r7430 r7432  
    77 
    88/** 
     9 * Tag data structure returned when parsing. 
    910 * 
    1011 * @author Aivar Grislis 
     
    1516    private String m_content; 
    1617    private String m_remainder; 
    17      
     18 
     19    /** 
     20     * Creates an empty tag. 
     21     */ 
    1822    public XMLTag() { 
    1923        m_name = EMPTY_STRING; 
     
    2226    } 
    2327 
     28    /** 
     29     * Creates a given tag. 
     30     * 
     31     * @param name 
     32     * @param content 
     33     * @param remainder 
     34     */ 
    2435    public XMLTag(String name, String content, String remainder) { 
    2536        m_name = name; 
     
    2839    } 
    2940 
     41    /** 
     42     * Get the name of the tag. 
     43     * 
     44     * @return 
     45     */ 
    3046    public String getName() { 
    3147        return m_name; 
    3248    } 
    3349 
     50    /** 
     51     * Gets the content of the tag. 
     52     * 
     53     * @return 
     54     */ 
    3455    public String getContent() { 
    3556        return m_content; 
    3657    } 
    3758 
     59    /** 
     60     * Gets the remainder of the XML string after the tag. 
     61     * 
     62     * @return 
     63     */ 
    3864    public String getRemainder() { 
    3965        return m_remainder; 
Note: See TracChangeset for help on using the changeset viewer.