Package clickDetector.localisation

Class GroupTethysLocCreator

java.lang.Object

clickDetector.localisation.GroupTethysLocCreator

All Implemented Interfaces:

LocalizationCreator

public class GroupTethysLocCreator
extends Object
implements LocalizationCreator

Constructor Summary

Constructors

Constructor	Description
GroupTethysLocCreator(GeneralGroupLocaliser generalGroupLocaliser)

Method Summary

Modifier and Type	Method	Description
boolean	checkDocument(LocalizationBuilder localizationBuilder)	Called after all localizations have been exported to check the document.
nilus.LocalizationType	createLocalization(LocalizationBuilder localizationBuilder, PamDataUnit dataUnit)	Create a localization record for export.
boolean	sortLocalisationCoordinates(LocalizationBuilder localizationBuilder, PamDataBlock dataBlock)	Sort out localization coordinates and set them in the current document in the Localization builder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GroupTethysLocCreator

public GroupTethysLocCreator(GeneralGroupLocaliser generalGroupLocaliser)

Method Details

sortLocalisationCoordinates

public boolean sortLocalisationCoordinates(LocalizationBuilder localizationBuilder,
 PamDataBlock dataBlock)

Description copied from interface: LocalizationCreator

Sort out localization coordinates and set them in the current document in the Localization builder. e.g. the TMA module should be able to work out at this point if it's working in 2 or 3 dimensions and whether it's outputting in cartesian or WGS84 coordinate systems. Whatever it chooses to do needs to be put into the current localization document / Effort / CoordinateReferenceSystem, which must then match whatever is output to the actual Localizations.

Specified by:

sortLocalisationCoordinates in interface LocalizationCreator

Parameters:

localizationBuilder - holder of current document and other information about the export.

dataBlock - Current datablock (though the localiser will probably know this)

Returns:

true if everything makes sense. false if it's not been possible to sort the coordinated, in which case export probably shouldn't proceed.

createLocalization

public nilus.LocalizationType createLocalization(LocalizationBuilder localizationBuilder,
 PamDataUnit dataUnit)

Description copied from interface: LocalizationCreator

Create a localization record for export. The coordinate used in the localization must match what what set in the call to sortLocalisationCoordinates

Specified by:

createLocalization in interface LocalizationCreator

Parameters:

localizationBuilder - holder of current document and other information about the export.

dataUnit - data unit containing the localization to export

Returns:

Localization record. Can be null if the data unit didn't have a localization, in which case nothing is written.

checkDocument

public boolean checkDocument(LocalizationBuilder localizationBuilder)

Description copied from interface: LocalizationCreator

Called after all localizations have been exported to check the document. Particularly regarding coordinate types. In principle, a lot of the functions of sortLocalisationCoordinates could be sorted out here if it's only possible to work out the coordinate system after going through all the data.

Specified by:

checkDocument in interface LocalizationCreator

Parameters:

localizationBuilder - holder of current document and other information about the export.

Returns:

true if everything OK and the document can be written to Tethys.