Module util
Back to master index
Module utilVersion:1.0.0
Package:org.astrogrid.acr.util
Utility Components
Configuration Points
util.selftest
1 configuration points
Service Points
util.selftest
util.tables
2 service points
Contribution to framework.acrServices
<acrService id="tables" interface="Tables" />
Contribution to framework.descriptors
<acr-module description="useful utility services" name="util" >
  • <component description="Utility functions for working with tables. Exposes some of the functionality of STIL<dl> <dt>See:</dt><dd> <a href="http://www.star.bris.ac.uk/~mbt/stil/">Stil Documentation</a>, Systems#listSchemes() List of supported URI schemes., Dal Examples of use., </dd></dl>" interface-class="org.astrogrid.acr.util.Tables" name="tables" >
    • <method description="Converts a table in a file between supported formats." name="convertFiles" >
      • <return description="" type="java.lang.Void" uitype="void" />
      • <param description="input location: may be any of the file schemes listed by <tt>Systems#listSchemes()</tt>, compressed using unix compress, gzip or bzip2" name="inLocation" type="java.net.URI" uitype="URI" />
      • <param description="input handler name: generally one of fits, votable, ascii, csv, ipac, wdc or null" name="inFormat" type="java.lang.String" uitype="String" />
      • <param description="output location: may be any of the file schemes listed by <tt>Systems#listSchemes()</tt>," name="outLocation" type="java.net.URI" uitype="URI" />
      • <param description="output format: generally one of fits, fits-plus, votable, votable-tabledata, votable-binary-inline, votable-binary-href, votable-fits-inline, votable-fits-href, text, ascii, csv, html, html-element, latex, latex-document or null" name="outFormat" type="java.lang.String" uitype="String" />
      </method>
    • <method description="Writes an in-memory table to a table in a file, converting between supported formats." name="convertToFile" >
      • <return description="" type="java.lang.Void" uitype="void" />
      • <param description="the input table" name="input" type="java.lang.String" uitype="String" />
      • <param description="input handler name: generally one of fits, votable, ascii, csv, ipac, wdc or null" name="inFormat" type="java.lang.String" uitype="String" />
      • <param description="output location:may be any of the file schemes listed by <tt>Systems#listSchemes()</tt>," name="outLocation" type="java.net.URI" uitype="URI" />
      • <param description="output format: generally one of fits, fits-plus, votable, votable-tabledata, votable-binary-inline, votable-binary-href, votable-fits-inline, votable-fits-href, text, ascii, csv, html, html-element, latex, latex-document or null" name="outFormat" type="java.lang.String" uitype="String" />
      </method>
    • <method description="Reads a table in a file into an in-memory table, converting between supported formats. <blockquote><b>Note: </b>Will only give good results for text-based table formats.</blockquote>" name="convertFromFile" >
      • <return description="the converted representation of the table." type="java.lang.String" uitype="String" />
      • <param description="input location:may be any of the file schemes listed by <tt>Systems#listSchemes()</tt>, compressed using unix compress, gzip or bzip2" name="inLocation" type="java.net.URI" uitype="URI" />
      • <param description="input handler name: generally one of fits, votable, ascii, csv, ipac, wdc or null" name="inFormat" type="java.lang.String" uitype="String" />
      • <param description="output format: generally one of fits, fits-plus, votable, votable-tabledata, votable-binary-inline, votable-binary-href, votable-fits-inline, votable-fits-href, text, ascii, csv, html, html-element, latex, latex-document or null" name="outFormat" type="java.lang.String" uitype="String" />
      </method>
    • <method description="Converts an in-memory table between supported formats. <blockquote><b>Note: </b>Will only give good results for text-based table formats.</blockquote>" name="convert" >
      • <return description="a table in the requested format." type="java.lang.String" uitype="String" />
      • <param description="the input table." name="input" type="java.lang.String" uitype="String" />
      • <param description="input handler name: generally one of fits, votable, ascii, csv, ipac, wdc or null" name="inFormat" type="java.lang.String" uitype="String" />
      • <param description="output format: generally one of fits, fits-plus, votable, votable-tabledata, votable-binary-inline, votable-binary-href, votable-fits-inline, votable-fits-href, text, ascii, csv, html, html-element, latex, latex-document or null" name="outFormat" type="java.lang.String" uitype="String" />
      </method>
    • <method description="list the table formats this component can write out to" name="listOutputFormats" >
      • <return description="" type="java.lang.String[]" uitype="String[]" />
      </method>
    • <method description="list the table formats this component can read in from" name="listInputFormats" >
      • <return description="" type="java.lang.String[]" uitype="String[]" />
      </method>
    </component>
</acr-module>
Contribution to framework.preferences
<preference advanced="false" default-value="true" name="util.selftest.runAtStartup" >
  • <ui-name >
    • Run self tests at startup
    </ui-name>
  • <description >
    • If true, self tests will be run automatically when VODesktop starts
    </description>
  • <units >
    • boolean
    </units>
</preference>
<preference advanced="true" default-value="5" name="util.selftest.testDelay" requires-restart="true" >
  • <ui-name >
    • Self test delay
    </ui-name>
  • <description >
    • Time to wait after startup before running self tests
    </description>
  • <units >
    • seconds
    </units>
</preference>
Contribution to hivemind.EagerLoad
<load service-id="tables" />
Contribution to hivemind.EagerLoad
<load service-id="selftest" />
Contribution to util.selftest
<object >
  • instance:org.astrogrid.desktop.modules.util.ConnectivityTests
</object>
<object >
  • instance:org.astrogrid.desktop.modules.util.MemoryTests
</object>
<object >
  • instance:org.astrogrid.desktop.modules.util.VersionTests
</object>
Implementation for service util.selftestIf:not (property java.awt.headless)
  • <invoke-factory service-id="hivemind.BuilderFactory" model="singleton" >
    • <construct class="org.astrogrid.desktop.modules.util.SelfTesterImpl" >
      • <service >
        • system.ui
        </service>
      • <service >
        • system.scheduler
        </service>
      • <configuration >
        • selftest
        </configuration>
      • <service >
        • system.systray
        </service>
      • <int >
        • ${util.selftest.testDelay}
        </int>
      • <boolean >
        • ${util.selftest.runAtStartup}
        </boolean>
      </construct>
    </invoke-factory>
  • <interceptor service-id="system.edtInvoke" />
Implementation for service util.selftestIf:property util.selftest.disabled

Back to master index