Plug-in 'help' implementation

AAVSO · Nov 5, 2023 · 3b80cdc · 3b80cdc
1 parent d5f9c17
commit 3b80cdc
Show file tree

Hide file tree

Showing 49 changed files with 476 additions and 8 deletions.
diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/AAVSOUploadFileFormatObservationSource.java b/plugin/src/org/aavso/tools/vstar/external/plugin/AAVSOUploadFileFormatObservationSource.java
@@ -97,6 +97,14 @@ public String getDescription() {
 	public String getDisplayName() {
 		return "New Star from AAVSO Upload Format File...";
 	}
+
+	/**
+	 * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName()
+	 */
+	@Override
+	public String getDocName() {
+		return "AAVSOUploadFileFormatObservationSource.pdf";
+	}
 
 	class AAVSOUploadFileFormatRetriever extends AbstractObservationRetriever {
 		private String fileType;

diff --git a/...n/src/org/aavso/tools/vstar/external/plugin/AAVSOnetEpochPhotometryObservationSource.java b/...n/src/org/aavso/tools/vstar/external/plugin/AAVSOnetEpochPhotometryObservationSource.java
@@ -62,4 +62,13 @@ public boolean requiresAuthentication() {
 	public boolean additionalAuthenticationSatisfied(LoginInfo loginInfo) {
 		return loginInfo.isMember();
 	}
+
+	/**
+	 * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName()
+	 */
+	@Override
+	public String getDocName() {
+		return "AAVSOEpochObservationSource.pdf";
+	}
+
 }
diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/APASSEpochPhotometryObservationSource.java b/plugin/src/org/aavso/tools/vstar/external/plugin/APASSEpochPhotometryObservationSource.java
@@ -66,4 +66,13 @@ public boolean requiresAuthentication() {
 	public boolean additionalAuthenticationSatisfied(LoginInfo loginInfo) {
 		return loginInfo.isMember();
 	}
+
+	/**
+	 * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName()
+	 */
+	@Override
+	public String getDocName() {
+		return "AAVSOEpochObservationSource.pdf";
+	}
+
 }
diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/ASASObservationSource.java b/plugin/src/org/aavso/tools/vstar/external/plugin/ASASObservationSource.java
@@ -90,6 +90,14 @@ public String getDisplayName() {
 		return "New Star from ASAS File...";
 	}
 
+	/**
+	 * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName()
+	 */
+	@Override
+	public String getDocName() {
+		return "ASAS Plug-In.pdf";
+	}
+
 	@Override
 	public AbstractObservationRetriever getObservationRetriever() {
 		return new ASASFileReader();

diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/ASASSNObservationSource.java b/plugin/src/org/aavso/tools/vstar/external/plugin/ASASSNObservationSource.java
@@ -178,6 +178,14 @@ public String getDescription() {
 	public String getDisplayName() {
 		return "New Star from ASAS-SN V2.0 File...";
 	}
+
+	/**
+	 * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName()
+	 */
+	@Override
+	public String getDocName() {
+		return "ASAS-SN Plug-In.pdf";
+	}
 
 	/**
 	 * @see org.aavso.tools.vstar.plugin.ObservationSourcePluginBase#getObservationRetriever()

diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/AoVPeriodSearch.java b/plugin/src/org/aavso/tools/vstar/external/plugin/AoVPeriodSearch.java
@@ -119,6 +119,14 @@ public String getDisplayName() {
 		return "AoV with Period Range";
 	}
 
+	/**
+	 * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName()
+	 */
+	@Override
+	public String getDocName() {
+		return "ASAS-SN Plug-In.pdf";
+	}
+
 	@Override
 	public void executeAlgorithm(List<ValidObservation> obs)
 			throws AlgorithmError, CancellationException {

diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/ApacheCommonsLoessFitter.java b/plugin/src/org/aavso/tools/vstar/external/plugin/ApacheCommonsLoessFitter.java
@@ -66,6 +66,14 @@ public String getDisplayName() {
 		return getDescription();
 	}
 
+	/**
+	 * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName()
+	 */
+	@Override
+	public String getDocName() {
+		return "ApacheCommonsLoessFilter.pdf";
+	}
+
 	@Override
 	public IModel getModel(List<ValidObservation> obs) {
 		LoessFitCreator fitCreator = new LoessFitCreator(obs);

diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/BMinusVObservationSource.java b/plugin/src/org/aavso/tools/vstar/external/plugin/BMinusVObservationSource.java
@@ -82,6 +82,14 @@ public String getDescription() {
 		return "B-V series creator";
 	}
 
+	/**
+	 * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName()
+	 */
+	@Override
+	public String getDocName() {
+		return "BMinusVObservationSource.pdf";
+	}
+
 	@Override
 	public AbstractObservationRetriever getObservationRetriever() {
 		return new BMinusVRetriever(requestTimeTolerance());

diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/CatalinaSkySurveyObservationSource.java b/plugin/src/org/aavso/tools/vstar/external/plugin/CatalinaSkySurveyObservationSource.java
@@ -96,6 +96,14 @@ public String getDisplayName() {
 		return "New Star from Catalina Sky Survey File...";
 	}
 
+	/**
+	 * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName()
+	 */
+	@Override
+	public String getDocName() {
+		return "VStar Retrieval of Catalina Sky Survey Data_updated20140602.pdf";
+	}
+
 	/**
 	 * @see org.aavso.tools.vstar.plugin.ObservationSourcePluginBase#getObservationRetriever()
 	 */

diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/CurrentModeANOVATool.java b/plugin/src/org/aavso/tools/vstar/external/plugin/CurrentModeANOVATool.java
@@ -72,4 +72,13 @@ public String getDescription() {
 	public String getDisplayName() {
 		return "Current Mode ANOVA";
 	}
+
+	/**
+	 * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName()
+	 */
+	@Override
+	public String getDocName() {
+		return "CurrentModeANOVA.pdf";
+	}
+
 }
diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/DASCHObservationSource.java b/plugin/src/org/aavso/tools/vstar/external/plugin/DASCHObservationSource.java
@@ -88,6 +88,14 @@ public String getDisplayName() {
 		return "New Star from DASCH File...";
 	}
 
+	/**
+	 * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName()
+	 */
+	@Override
+	public String getDocName() {
+		return "DASCH Plug-In for VStar.pdf";
+	}
+
 	@Override
 	public List<String> getAdditionalFileExtensions() {
 		List<String> dbExtension = new ArrayList<String>();

diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/DescStatsBySeries.java b/plugin/src/org/aavso/tools/vstar/external/plugin/DescStatsBySeries.java
@@ -188,6 +188,14 @@ public String getDisplayName() {
 		return "Descriptive statistics by series";
 	}
 
+	/**
+	 * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName()
+	 */
+	@Override
+	public String getDocName() {
+		return "DescStatsBySeries.pdf";
+	}
+
     // The calcMedian method can be moved to DescStats;
 	// some checks are excessive here. 
 

diff --git a/...in/src/org/aavso/tools/vstar/external/plugin/FlexibleTextFileFormatObservationSource.java b/...in/src/org/aavso/tools/vstar/external/plugin/FlexibleTextFileFormatObservationSource.java
@@ -200,6 +200,14 @@ public String getDisplayName() {
 		return "New Star from Flexible Text Format File...";
 	}
 
+	/**
+	 * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName()
+	 */
+	@Override
+	public String getDocName() {
+		return "FlexibleTextFileFormat Plug-In.pdf";
+	}
+
 	class FlexibleTextFileFormatRetriever extends AbstractObservationRetriever {
 		private char delimiter = DEFAULT_DELIMITER;
 		private boolean multispaceDelimiter = false;

diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/FourierModelCreator.java b/plugin/src/org/aavso/tools/vstar/external/plugin/FourierModelCreator.java
@@ -51,6 +51,14 @@ public String getDisplayName() {
 		return "Fourier Model";
 	}
 
+	/**
+	 * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName()
+	 */
+	@Override
+	public String getDocName() {
+		return "FourierModelCreator.pdf";
+	}
+
 	@Override
 	public IModel getModel(List<ValidObservation> obs) {
 		PeriodAnalysisDerivedMultiPeriodicModel model = null;		

diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/GAIADR2XformFileObSource.java b/plugin/src/org/aavso/tools/vstar/external/plugin/GAIADR2XformFileObSource.java
@@ -71,7 +71,15 @@ public String getDescription() {
 	public String getDisplayName() {
 		return "New Star from Gaia DR2/DR3 Photometry File...";
 	}
-
+
+	/**
+	 * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName()
+	 */
+	@Override
+	public String getDocName() {
+		return "GAIAPluginDoc.pdf";
+	}
+
 	/**
 	 * @see org.aavso.tools.vstar.plugin.ObservationSourcePluginBase#getObservationRetriever()
 	 */

diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/GAIADR2XformObSource.java b/plugin/src/org/aavso/tools/vstar/external/plugin/GAIADR2XformObSource.java
@@ -126,6 +126,14 @@ public String getDisplayName() {
 		return "New Star from Gaia DR2/DR3 Photometry ...";
 	}
 
+	/**
+	 * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName()
+	 */
+	@Override
+	public String getDocName() {
+		return "GAIAPluginDoc.pdf";
+	}
+
 	@SuppressWarnings("serial")
 	private class GAIAParameterDialog extends AbstractOkCancelDialog {
 

diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/HJDConverter.java b/plugin/src/org/aavso/tools/vstar/external/plugin/HJDConverter.java
@@ -54,6 +54,14 @@ public String getDescription() {
 		return "Heliocentric JD Converter";
 	}
 
+	/**
+	 * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName()
+	 */
+	@Override
+	public String getDocName() {
+		return "HJD Converter.pdf";
+	}
+
 	@Override
 	public void invoke(ISeriesInfoProvider seriesInfo) {
 		NewStarMessage msg = Mediator.getInstance().getLatestNewStarMessage();

diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/HipparcosObservationSource.java b/plugin/src/org/aavso/tools/vstar/external/plugin/HipparcosObservationSource.java
@@ -81,6 +81,14 @@ public String getDisplayName() {
 		return "New Star from Hipparcos File...";
 	}
 
+	/**
+	 * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName()
+	 */
+	@Override
+	public String getDocName() {
+		return "HipparcosObservationSource.pdf";
+	}
+
 	class HipparcosFileReader extends AbstractObservationRetriever {
 
 		private State state;

diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/JDToDateTool.java b/plugin/src/org/aavso/tools/vstar/external/plugin/JDToDateTool.java
@@ -73,6 +73,14 @@ public String getDisplayName() {
 		return "JD to Calendar Date";
 	}
 
+	/**
+	 * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName()
+	 */
+	@Override
+	public String getDocName() {
+		return "JDToDateTool.pdf";
+	}
+
 	// Current Julian Day value
     private static double julianDayNow()
     {

diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/JulianDateObservationsFilter.java b/plugin/src/org/aavso/tools/vstar/external/plugin/JulianDateObservationsFilter.java
@@ -46,5 +46,13 @@ public String getDescription() {
 	public String getDisplayName() {
 		return "Julian Date Observations Filter";
 	}
+
+	/**
+	 * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName()
+	 */
+	@Override
+	public String getDocName() {
+		return "JulianDateObservationsFilter.pdf";
+	}
 
 }
diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/KeplerFITSObservationSource.java b/plugin/src/org/aavso/tools/vstar/external/plugin/KeplerFITSObservationSource.java
@@ -138,6 +138,14 @@ public String getDisplayName() {
 		return str;
 	}
 
+	/**
+	 * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName()
+	 */
+	@Override
+	public String getDocName() {
+		return "INSTRUCTIONS FOR USING THE KEPLER FITS v2.2 FILE VStar PLUG IN.pdf";
+	}
+
 	@Override
 	public List<String> getAdditionalFileExtensions() {
 		List<String> extensions = new ArrayList<String>();

diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/LightKurveFITSObservationSource.java b/plugin/src/org/aavso/tools/vstar/external/plugin/LightKurveFITSObservationSource.java
@@ -76,6 +76,14 @@ public String getDisplayName() {
 		return "New Star from Lightkurve FITS File v0.4...";
 	}
 
+	/**
+	 * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName()
+	 */
+	@Override
+	public String getDocName() {
+		return "Lightkurve_FITS_observation_source.pdf";
+	}
+
 	@Override
 	public List<String> getAdditionalFileExtensions() {
 		List<String> extensions = new ArrayList<String>();

diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/MagnitudeBaselineShifter.java b/plugin/src/org/aavso/tools/vstar/external/plugin/MagnitudeBaselineShifter.java
@@ -56,6 +56,14 @@ public String getDescription() {
 		return "Magnitude Baseline Shifter";
 	}
 
+	/**
+	 * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName()
+	 */
+	@Override
+	public String getDocName() {
+		return "Magnitude Baseline Shifter Plug-In.pdf";
+	}
+
 	@Override
 	public IUndoableAction createAction(ISeriesInfoProvider seriesInfo,
 			Set<SeriesType> series) {

diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/MeanTimeBetweenSelectionTool.java b/plugin/src/org/aavso/tools/vstar/external/plugin/MeanTimeBetweenSelectionTool.java
@@ -61,6 +61,14 @@ public String getDescription() {
 	public String getDisplayName() {
 		return "Mean time between selections";
 	}
+
+	/**
+	 * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName()
+	 */
+	@Override
+	public String getDocName() {
+		return "MeanTimeBetweenSelectionTool.pdf";
+	}
 
 	@SuppressWarnings("serial")
 	class ObservationCollectionDialog extends JDialog {

diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/NSVSObservationSource.java b/plugin/src/org/aavso/tools/vstar/external/plugin/NSVSObservationSource.java
@@ -64,6 +64,14 @@ public String getDisplayName() {
 		return "New Star from NSVS File...";
 	}
 
+	/**
+	 * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName()
+	 */
+	@Override
+	public String getDocName() {
+		return "NSVS Plug In.pdf";
+	}
+
 	class NSVSFileReader extends AbstractObservationRetriever {
 
 		private State state;

diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/ObserverListFilter.java b/plugin/src/org/aavso/tools/vstar/external/plugin/ObserverListFilter.java
@@ -75,6 +75,14 @@ public String getDisplayName() {
 		return "Observer List Filter";
 	}
 
+	/**
+	 * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName()
+	 */
+	@Override
+	public String getDocName() {
+		return "ObserverListFilter.pdf";
+	}
+
 	public String[] getObserverList() {
 		String str = JOptionPane.showInputDialog("Enter observer codes separated by spaces:");