Changeset 3891


Ignore:
Timestamp:
Oct 30, 2007, 1:58:48 PM (16 years ago)
Author:
Nicklas Nordborg
Message:

References #746: Transfer existing UML diagrams to latest MagicDraw?

Moved the following diagrams:

  • Hardware/software
  • Reporters
  • Quota and disk usage
Location:
trunk/doc/src
Files:
3 added
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/src/docbook/developerdoc/api_overview.xml

    r3872 r3891  
    633633    <sect2 id="data_api.wares">
    634634      <title>Hardware and software</title>
     635      <para>
     636         This section gives an overview of hardware and software in BASE.
     637      </para>
     638     
     639      <sect3 id="data_api.wares.uml">
     640        <title>UML diagram</title>
     641       
     642        <figure id="data_api.figures.wares">
     643          <title>Hardware and software</title>
     644          <screenshot>
     645            <mediaobject>
     646              <imageobject>
     647                <imagedata
     648                  fileref="figures/uml/datalayer.wares.png" format="PNG" />
     649              </imageobject>
     650            </mediaobject>
     651          </screenshot>
     652        </figure>
     653      </sect3>
     654     
     655      <sect3 id="data_api.wares.description">
     656        <title>Hardware and software</title>
     657        <para>
     658          BASE is pre-installed with a set of hardware and software types.
     659          They are typically used to filter the registered hardware and software
     660          depending on what a user is doing. For example, when adding raw data
     661          to BASE a user can select a scanner. The GUI will display the hardware
     662          that has been registered as <emphasis>scanner</emphasis> hardware types.
     663          Other hardware types are <emphasis>hybridization station</emphasis>
     664          and <emphasis>print robot</emphasis>. An administrator may register more
     665          hardware and software types.
     666        </para>
     667      </sect3>
    635668    </sect2>
    636669   
    637670    <sect2 id="data_api.reporters">
    638671      <title>Reporters</title>
     672      <para>
     673         This section gives an overview of hardware and software in BASE.
     674      </para>
     675     
     676      <sect3 id="data_api.reporters.uml">
     677        <title>UML diagram</title>
     678       
     679        <figure id="data_api.figures.reporters">
     680          <title>Reporters</title>
     681          <screenshot>
     682            <mediaobject>
     683              <imageobject>
     684                <imagedata
     685                  fileref="figures/uml/datalayer.reporters.png" format="PNG" />
     686              </imageobject>
     687            </mediaobject>
     688          </screenshot>
     689        </figure>
     690      </sect3>
     691     
     692      <sect3 id="data_api.reporters.description">
     693        <title>Reporters</title>
     694        <para>
     695          The <classname>ReporterData</classname> class holds information about reporters.
     696          The <property>externalId</property> is a required property that must be unique
     697          among all reporters. The external ID is the value BASE uses to match
     698          reporters when importing data from files.
     699        </para>
     700       
     701        <para>
     702          The <classname>ReporterData</classname> is an <emphasis>extendable</emphasis>
     703          class, which means that the server administrator can define additional
     704          columns (=annotations) in the reporters table. These are accessed with
     705          the <methodname>ReporterData.getExtended()</methodname> and
     706          <methodname>ReporterData.setExtended()</methodname> methods.
     707          See <xref linkend="appendix.extendedproperties" /> for more information about
     708          this.
     709        </para>
     710       
     711        <para>
     712          The <classname>ReporterData</classname> is also a <emphasis>batchable</emphasis>
     713          class which means that there is no corresponding class in the core
     714          layer. Client applications and plug-ins should work directly with
     715          the <classname>ReporterData</classname> class. To help manage the reporters
     716          there is the <classname>Reporter</classname> and <classname>ReporterBatcher</classname>
     717          classes. The main reason for this
     718          is to increase the performance and lower the memory usage by bypassing
     719          internal caching in the core and Hibernate. Performance is also
     720          increased by the batchers which uses more efficient SQL against the
     721          database than Hibernate.
     722        </para>
     723       
     724        <para>
     725          The <property>lastUpdate</property> property holds the data and time
     726          the reporter information was last updated. The value is managed automatically
     727          by the <classname>ReporterBatcher</classname> class.
     728        </para>
     729      </sect3>
     730     
     731      <sect3 id="data_api.reporters.lists">
     732        <title>Reporter lists</title>
     733       
     734        <para>
     735          Reporter lists can be used to group reporters that are somehow related
     736          to each other. This could for example be a list of interesting reporters
     737          found in the analysis of an experiment. Each reporter in the list may
     738          optionally be assigned a score. The meaning of the score value is not
     739          interpreted by BASE.
     740        </para>
     741       
     742      </sect3>
     743     
     744     
    639745    </sect2>
    640746
    641747    <sect2 id="data_api.quota">
    642748      <title>Quota and disk usage</title>
     749      <para>
     750         This section gives an overview of quota system in BASE
     751         and how the disk usage is kept track of.
     752      </para>
     753     
     754      <sect3 id="data_api.quota.uml">
     755        <title>UML diagram</title>
     756       
     757        <figure id="data_api.figures.quota">
     758          <title>Quota and disk usage</title>
     759          <screenshot>
     760            <mediaobject>
     761              <imageobject>
     762                <imagedata
     763                  fileref="figures/uml/datalayer.quota.png" format="PNG" />
     764              </imageobject>
     765            </mediaobject>
     766          </screenshot>
     767        </figure>
     768      </sect3>
     769     
     770      <sect3 id="data_api.quota.description">
     771        <title>Quota</title>
     772       
     773        <para>
     774          The <classname>QuotaData</classname> holds information about a
     775          single quota registration. The same quota may be used by many different users
     776          and groups. This object encapsulates allowed
     777          quota values for different types of quota types and locations.
     778          BASE defines several quota types (file, raw data and experiment),
     779          and locations (primary, secondary and offline).
     780        </para>
     781       
     782        <para>
     783          The <property>quotaValues</property> property is a map from
     784          <classname>QuotaIndex</classname> to maximum byte values.
     785          This map must contain at least one entry for the total
     786          quota at the primary location.
     787        </para>
     788       
     789      </sect3>
     790     
     791      <sect3 id="data_api.quota.diskusage">
     792        <title>Disk usage</title>
     793       
     794        <para>
     795          A <interfacename>DiskConsumableData</interfacename> (for example a file)
     796          item is automatically linked to a <classname>DiskUsageData</classname>
     797          item. This holds information about the number of bytes,
     798          the location and quota type the item uses. It also holds information
     799          about which user and group (optional) that should be charged for the disk usage.
     800          The user is always the owner of the item.
     801        </para>
     802
     803      </sect3>
     804     
    643805    </sect2>
    644806
Note: See TracChangeset for help on using the changeset viewer.