Package skyview.survey
Class XMLSurveyFinder
java.lang.Object
skyview.survey.XMLSurveyFinder
- All Implemented Interfaces:
SurveyFinder
This class provides functionality to translate survey
names into associated survey description files.
-
Nested Class Summary
Nested Classes -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
dump()
Create a cached translation between survey names and files.Do we have this survey?Find the survey file given the short nameString[]
What surveys do we know about?protected void
Get surveys from a user manifest.protected void
getSurveysFromManifest
(boolean dump) protected void
Get the surveys in the document root areaprotected void
Get user specified surveysprotected boolean
loadSurveyCacheFromFile
(String hashFile) protected boolean
protected String
Get path to the local cache using the path to the jar file being executed.static void
Main class.protected String
protected void
Read XML files to populate survey hash in memory.void
protected String
-
Constructor Details
-
XMLSurveyFinder
public XMLSurveyFinder()Set up the SurveyFinder and populate the map. Overloaded to pass a flag for whether the context is simply to dump the survey manifest. -
XMLSurveyFinder
public XMLSurveyFinder(boolean dump)
-
-
Method Details
-
dump
public void dump()Create a cached translation between survey names and files. This can be used to save a little time when running SkyView. Note that the hash that is written was already created in the XMLSurveyFinder constructor above. -
read
-
getSurveysFromRoot
protected void getSurveysFromRoot()Get the surveys in the document root area -
getSurveysFromUser
protected void getSurveysFromUser()Get user specified surveys -
getSurveysFromMainifest
protected void getSurveysFromMainifest()Get surveys from a user manifest. This is how SkyView-in-a-Jar gets its surveys. Result is that the XMLSurveyFinder's hash object is filled. Overloaded for case of dump -
getSurveysFromManifest
protected void getSurveysFromManifest(boolean dump) -
localCacheName
Get path to the local cache using the path to the jar file being executed. -
remoteCacheName
-
manifestName
-
manifestToHash
protected void manifestToHash()Read XML files to populate survey hash in memory. -
loadSurveyCacheFromUrl
-
loadSurveyCacheFromFile
-
find
Do we have this survey?- Specified by:
find
in interfaceSurveyFinder
-
findFile
Find the survey file given the short name -
getSurveys
What surveys do we know about?- Specified by:
getSurveys
in interfaceSurveyFinder
-
main
Main class.
With no arguments simply list all of the survey names.
With the single argument "dump": Create a cached names file that can be used to speed up the initialization.
With any other single argument: show the metadata for the selected survey
With multiple arguments survey metakey1 [metakey2...] show the requested metadata for the requested survey
-