Reporters

NOTE! This document is outdated and has been replaced with newer documentation. See The database schema and the Data Layer API

This document covers the details about how BASE handles reporters (clones, oligos, etc.).

See also

Core specification

Last updated: $Date: 2009-04-06 14:52:39 +0200 (mÃ¥, 06 apr 2009) $

Reporters

The ReporterData [API] class holds information about reporters. The externalId is a unique name for the reporter. In the default setup this table contains nothing more than the external ID, gene name and symbol. This class doesn't have an item class in the core, instead it has an utility class Reporter [API] and is saved with ReporterBatcher [API].

A server administrator may modify this class table to also include other information. Columns for that information is added directly into this table. The name and type of the columns must also be described in an XML configuration file. The format of this file is described by the ExtendableData [API]. Here is an example:

<?xml version="1.0" ?>
<!DOCTYPE extended-properties SYSTEM "extended-properties.dtd" >
<extended-properties>
   <class name="ReporterData">
      <property
         name="UniGene cluster"
         type="string"
         column="cluster"
         length="255"
         null="true"
         description="The UniGene cluster ID"
      />
   </class>
</extended-properties>

ReporterTypes

The ReporterTypeData [API] class holds reporter type information. A reporter may have, but is not required to have a type. The main reason for a reporter to have a type is to make it easier for client application to filter the reporter list.