uk.ac.vamsas.test.simpleclient
Class ArchiveReports

java.lang.Object
  extended byuk.ac.vamsas.test.simpleclient.ArchiveReports

public class ArchiveReports
extends java.lang.Object

this class contains static methods for writing info to stdout about a vamsas document Methods have a 'cascade' switch to indicate if sub-objects should have info printed on them. Methods return true or false - indicating if the Vobject was valid or not TODO: LATER: propagate true/false return so that an invalid vamsas Vobject invalidates the whole document

Author:
jimp

Constructor Summary
ArchiveReports()
           
 
Method Summary
static boolean alignmentReport(Alignment[] al, boolean cascade, java.io.PrintStream outstr)
           
static boolean appDataEntryReport(AppData appD, VamsasArchiveReader archive, boolean cascade, java.io.PrintStream outstr)
           
static boolean appDataReport(ApplicationData appD, VamsasArchiveReader archive, boolean cascade, java.io.PrintStream outstr)
           
static boolean datasetReport(DataSet ds, boolean cascade, java.io.PrintStream outstr)
           
static void outputVobjectState(Vobject v, java.io.PrintStream outstr)
           
static boolean reportDocument(VamsasDocument document, VamsasArchiveReader archive, boolean cascade, java.io.PrintStream outstr)
           
static boolean reportProvenance(Provenance p, java.io.PrintStream outstr)
          print an informative summary on a VamsasDocument
static boolean rootReport(VAMSAS[] roots, boolean cascade, java.io.PrintStream outstr)
          summarises all the datasets in a vamsas document.
static boolean treeReport(Tree t, boolean cascade, java.io.PrintStream outstr)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ArchiveReports

public ArchiveReports()
Method Detail

reportProvenance

public static boolean reportProvenance(Provenance p,
                                       java.io.PrintStream outstr)
print an informative summary on a VamsasDocument

Parameters:
outstr - TODO
Returns:

appDataEntryReport

public static boolean appDataEntryReport(AppData appD,
                                         VamsasArchiveReader archive,
                                         boolean cascade,
                                         java.io.PrintStream outstr)

appDataReport

public static boolean appDataReport(ApplicationData appD,
                                    VamsasArchiveReader archive,
                                    boolean cascade,
                                    java.io.PrintStream outstr)

reportDocument

public static boolean reportDocument(VamsasDocument document,
                                     VamsasArchiveReader archive,
                                     boolean cascade,
                                     java.io.PrintStream outstr)

rootReport

public static boolean rootReport(VAMSAS[] roots,
                                 boolean cascade,
                                 java.io.PrintStream outstr)
summarises all the datasets in a vamsas document.

Parameters:
roots -
cascade - TODO
outstr - TODO
Returns:

outputVobjectState

public static void outputVobjectState(Vobject v,
                                      java.io.PrintStream outstr)

datasetReport

public static boolean datasetReport(DataSet ds,
                                    boolean cascade,
                                    java.io.PrintStream outstr)

alignmentReport

public static boolean alignmentReport(Alignment[] al,
                                      boolean cascade,
                                      java.io.PrintStream outstr)

treeReport

public static boolean treeReport(Tree t,
                                 boolean cascade,
                                 java.io.PrintStream outstr)