diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/AAVSOUploadFileFormatObservationSource.java b/plugin/src/org/aavso/tools/vstar/external/plugin/AAVSOUploadFileFormatObservationSource.java index 13f1af323..e42360489 100644 --- 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/plugin/src/org/aavso/tools/vstar/external/plugin/AAVSOnetEpochPhotometryObservationSource.java b/plugin/src/org/aavso/tools/vstar/external/plugin/AAVSOnetEpochPhotometryObservationSource.java index 550f031c4..4c283ae08 100644 --- a/plugin/src/org/aavso/tools/vstar/external/plugin/AAVSOnetEpochPhotometryObservationSource.java +++ b/plugin/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 index 77472f883..26cf9b1cd 100644 --- 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 index da93ad7f4..f23046652 100644 --- 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 index a024c617c..df816ac8f 100644 --- 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 index 0843d791e..0bd32b08e 100644 --- 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 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 index 3495ae10e..ce576cf50 100644 --- 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 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 index 1c5b34048..403514c12 100644 --- 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 index 757e3cc9e..3cda82d0c 100644 --- 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 index fa210252d..b2dfc0f21 100644 --- 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 index 030256139..d07e71e17 100644 --- 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 getAdditionalFileExtensions() { List dbExtension = new ArrayList(); diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/DescStatsBySeries.java b/plugin/src/org/aavso/tools/vstar/external/plugin/DescStatsBySeries.java index 4293cc016..7a21bd2df 100644 --- 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/plugin/src/org/aavso/tools/vstar/external/plugin/FlexibleTextFileFormatObservationSource.java b/plugin/src/org/aavso/tools/vstar/external/plugin/FlexibleTextFileFormatObservationSource.java index 996943e45..e2812c53c 100644 --- a/plugin/src/org/aavso/tools/vstar/external/plugin/FlexibleTextFileFormatObservationSource.java +++ b/plugin/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 index f9a83b3ce..020c1014f 100644 --- 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 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 index cb39631a4..8a6354d5c 100644 --- 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 index 551d04295..064898259 100755 --- 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 index 4362102a0..c01f89984 100644 --- 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 index e11920b2e..0b490f24b 100644 --- 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 index 5bf1bf3b6..d1497ebf3 100644 --- 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 index 0f0338c56..b1ac9a32d 100644 --- 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 index 7677ae5fd..a0286af47 100644 --- 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 getAdditionalFileExtensions() { List extensions = new ArrayList(); diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/LightKurveFITSObservationSource.java b/plugin/src/org/aavso/tools/vstar/external/plugin/LightKurveFITSObservationSource.java index ca6670a9d..acafca23e 100644 --- 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 getAdditionalFileExtensions() { List extensions = new ArrayList(); diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/MagnitudeBaselineShifter.java b/plugin/src/org/aavso/tools/vstar/external/plugin/MagnitudeBaselineShifter.java index 64c7a1039..2e7b99285 100644 --- 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 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 index 81ab0f679..65c87fcdb 100644 --- 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 index d7329440c..472c75843 100644 --- 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 index ae6ae5a64..c7683b740 100644 --- 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:"); diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/ObserversBySeries.java b/plugin/src/org/aavso/tools/vstar/external/plugin/ObserversBySeries.java index 722d84598..e2f24189c 100644 --- a/plugin/src/org/aavso/tools/vstar/external/plugin/ObserversBySeries.java +++ b/plugin/src/org/aavso/tools/vstar/external/plugin/ObserversBySeries.java @@ -96,4 +96,13 @@ public String getDescription() { public String getDisplayName() { return "Observers by Series"; } + + /** + * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName() + */ + @Override + public String getDocName() { + return "ObserversBySeries.pdf"; + } + } \ No newline at end of file diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/PeriodLuminosityDistanceCalculator.java b/plugin/src/org/aavso/tools/vstar/external/plugin/PeriodLuminosityDistanceCalculator.java index 02dc0a1a5..db526b8d3 100644 --- a/plugin/src/org/aavso/tools/vstar/external/plugin/PeriodLuminosityDistanceCalculator.java +++ b/plugin/src/org/aavso/tools/vstar/external/plugin/PeriodLuminosityDistanceCalculator.java @@ -252,4 +252,14 @@ public String getDescription() { public String getDisplayName() { return "Leavitt's Law distance calculator"; } + + + /** + * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName() + */ + @Override + public String getDocName() { + return "LeavittsLaw.pdf"; + } + } diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/QLPFITSObservationSource.java b/plugin/src/org/aavso/tools/vstar/external/plugin/QLPFITSObservationSource.java index 9e8bc897f..06373e4ac 100644 --- a/plugin/src/org/aavso/tools/vstar/external/plugin/QLPFITSObservationSource.java +++ b/plugin/src/org/aavso/tools/vstar/external/plugin/QLPFITSObservationSource.java @@ -89,6 +89,14 @@ public String getDisplayName() { return str; } + /** + * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName() + */ + @Override + public String getDocName() { + return "QLP_FITS_PlugIn.pdf"; + } + @Override public List getAdditionalFileExtensions() { List extensions = new ArrayList(); diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/SuperWASPFITSObservationSource.java b/plugin/src/org/aavso/tools/vstar/external/plugin/SuperWASPFITSObservationSource.java index 2328beaa7..592b467a1 100644 --- a/plugin/src/org/aavso/tools/vstar/external/plugin/SuperWASPFITSObservationSource.java +++ b/plugin/src/org/aavso/tools/vstar/external/plugin/SuperWASPFITSObservationSource.java @@ -119,6 +119,14 @@ public String getDisplayName() { return "New Star from SuperWASP FITS File v2..."; } + /** + * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName() + */ + @Override + public String getDocName() { + return "SuperWASPFITSObservationSource.pdf"; + } + class FITSObservationRetriever extends AbstractObservationRetriever { public FITSObservationRetriever() { diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/VSXquery.java b/plugin/src/org/aavso/tools/vstar/external/plugin/VSXquery.java index 49e94cf77..c0e5dca28 100644 --- a/plugin/src/org/aavso/tools/vstar/external/plugin/VSXquery.java +++ b/plugin/src/org/aavso/tools/vstar/external/plugin/VSXquery.java @@ -104,6 +104,14 @@ public String getDisplayName() { return "VSX Query"; } + /** + * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName() + */ + @Override + public String getDocName() { + return "VSX_Query_Plugin.pdf"; + } + class DoubleField2 extends DoubleField { private int MIN_DECIMAL_PLACES = 20; diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/VeLaModelCreator.java b/plugin/src/org/aavso/tools/vstar/external/plugin/VeLaModelCreator.java index 71e775ef4..b7bf1300d 100644 --- a/plugin/src/org/aavso/tools/vstar/external/plugin/VeLaModelCreator.java +++ b/plugin/src/org/aavso/tools/vstar/external/plugin/VeLaModelCreator.java @@ -66,6 +66,14 @@ public String getDisplayName() { return "VeLa Model"; } + /** + * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName() + */ + @Override + public String getDocName() { + return "VeLa Model Creator Plug-In.pdf"; + } + @Override public IModel getModel(List obs) { VeLaModel velaModel = new VeLaModel(obs); diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/VeLaObSource.java b/plugin/src/org/aavso/tools/vstar/external/plugin/VeLaObSource.java index 9c87a7fd9..5dbc36b7c 100644 --- a/plugin/src/org/aavso/tools/vstar/external/plugin/VeLaObSource.java +++ b/plugin/src/org/aavso/tools/vstar/external/plugin/VeLaObSource.java @@ -134,6 +134,14 @@ public String getDisplayName() { return "New Star from " + OBJ_NAME + "..."; } + /** + * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName() + */ + @Override + public String getDocName() { + return "VeLa Model Source Plug-In.pdf"; + } + @Override public AbstractObservationRetriever getObservationRetriever() { if (paramDialog == null) diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/VeLaObservationTransformer.java b/plugin/src/org/aavso/tools/vstar/external/plugin/VeLaObservationTransformer.java index a3dae66c8..3c9fb336d 100644 --- a/plugin/src/org/aavso/tools/vstar/external/plugin/VeLaObservationTransformer.java +++ b/plugin/src/org/aavso/tools/vstar/external/plugin/VeLaObservationTransformer.java @@ -62,6 +62,14 @@ public String getDescription() { return "VeLa observation transformation tool"; } + /** + * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName() + */ + @Override + public String getDocName() { + return "VeLa Observation Transformer Plug-In.pdf"; + } + @Override public IUndoableAction createAction(ISeriesInfoProvider seriesInfo, Set series) { diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/ZTFFileObSource.java b/plugin/src/org/aavso/tools/vstar/external/plugin/ZTFFileObSource.java index 56cb69961..a41aa2a63 100644 --- a/plugin/src/org/aavso/tools/vstar/external/plugin/ZTFFileObSource.java +++ b/plugin/src/org/aavso/tools/vstar/external/plugin/ZTFFileObSource.java @@ -54,4 +54,12 @@ public String getDisplayName() { return "New Star from ZTF Photometry File ..."; } + /** + * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName() + */ + @Override + public String getDocName() { + return "ZTFPluginDoc.pdf"; + } + } diff --git a/plugin/src/org/aavso/tools/vstar/external/plugin/ZTFObSource.java b/plugin/src/org/aavso/tools/vstar/external/plugin/ZTFObSource.java index 2a8c368ea..d4bb89d1c 100644 --- a/plugin/src/org/aavso/tools/vstar/external/plugin/ZTFObSource.java +++ b/plugin/src/org/aavso/tools/vstar/external/plugin/ZTFObSource.java @@ -125,6 +125,15 @@ public String getDisplayName() { return "New Star from ZTF Photometry ..."; } + /** + * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName() + */ + @Override + public String getDocName() { + return "ZTFPluginDoc.pdf"; + } + + @SuppressWarnings("serial") class ZTFParameterDialog extends AbstractOkCancelDialog { diff --git a/src/org/aavso/tools/vstar/plugin/CustomFilterPluginBase.java b/src/org/aavso/tools/vstar/plugin/CustomFilterPluginBase.java index 6942a7792..b75240d25 100644 --- a/src/org/aavso/tools/vstar/plugin/CustomFilterPluginBase.java +++ b/src/org/aavso/tools/vstar/plugin/CustomFilterPluginBase.java @@ -63,6 +63,14 @@ abstract public class CustomFilterPluginBase implements IPlugin { */ abstract protected Pair filter(List obs); + /** + * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName() + */ + @Override + public String getDocName() { + return null; + } + /** * @see org.aavso.tools.vstar.plugin.IPlugin#getGroup() */ diff --git a/src/org/aavso/tools/vstar/plugin/GeneralToolPluginBase.java b/src/org/aavso/tools/vstar/plugin/GeneralToolPluginBase.java index 7a43da520..213d38dcf 100644 --- a/src/org/aavso/tools/vstar/plugin/GeneralToolPluginBase.java +++ b/src/org/aavso/tools/vstar/plugin/GeneralToolPluginBase.java @@ -42,6 +42,14 @@ abstract public class GeneralToolPluginBase implements IPlugin { */ abstract public void invoke(); + /** + * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName() + */ + @Override + public String getDocName() { + return null; + } + /** * @see org.aavso.tools.vstar.plugin.IPlugin#getGroup() */ diff --git a/src/org/aavso/tools/vstar/plugin/IPlugin.java b/src/org/aavso/tools/vstar/plugin/IPlugin.java index ceb387f40..ac17be160 100644 --- a/src/org/aavso/tools/vstar/plugin/IPlugin.java +++ b/src/org/aavso/tools/vstar/plugin/IPlugin.java @@ -52,6 +52,11 @@ public interface IPlugin { */ abstract public String getDescription(); + /** + * Get a document file name for this plugin. + */ + abstract public String getDocName(); + /** * Get the group to which this plugin belongs (may be null). */ diff --git a/src/org/aavso/tools/vstar/plugin/ModelCreatorPluginBase.java b/src/org/aavso/tools/vstar/plugin/ModelCreatorPluginBase.java index 9a0370a5e..9d2e653c0 100644 --- a/src/org/aavso/tools/vstar/plugin/ModelCreatorPluginBase.java +++ b/src/org/aavso/tools/vstar/plugin/ModelCreatorPluginBase.java @@ -61,6 +61,14 @@ abstract public class ModelCreatorPluginBase implements IPlugin { @Override abstract public String getDisplayName(); + /** + * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName() + */ + @Override + public String getDocName() { + return null; + } + /** * Set parameters for this model creator plugin invocation. * @param params The parameters to set. diff --git a/src/org/aavso/tools/vstar/plugin/ObservationSinkPluginBase.java b/src/org/aavso/tools/vstar/plugin/ObservationSinkPluginBase.java index 0816343e2..53c7aa40f 100644 --- a/src/org/aavso/tools/vstar/plugin/ObservationSinkPluginBase.java +++ b/src/org/aavso/tools/vstar/plugin/ObservationSinkPluginBase.java @@ -70,6 +70,14 @@ public Map getDelimiterNameValuePairs() { public Map getDelimiterSuffixValuePairs() { return null; } + + /** + * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName() + */ + @Override + public String getDocName() { + return null; + } /** * @see org.aavso.tools.vstar.plugin.IPlugin#getGroup() diff --git a/src/org/aavso/tools/vstar/plugin/ObservationSourcePluginBase.java b/src/org/aavso/tools/vstar/plugin/ObservationSourcePluginBase.java index ede9d2ffb..9708fd032 100644 --- a/src/org/aavso/tools/vstar/plugin/ObservationSourcePluginBase.java +++ b/src/org/aavso/tools/vstar/plugin/ObservationSourcePluginBase.java @@ -109,6 +109,15 @@ public String getCurrentStarName() { */ public abstract InputType getInputType(); + + /** + * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName() + */ + @Override + public String getDocName() { + return null; + } + /** * @see org.aavso.tools.vstar.plugin.IPlugin#getGroup() */ diff --git a/src/org/aavso/tools/vstar/plugin/ObservationToolPluginBase.java b/src/org/aavso/tools/vstar/plugin/ObservationToolPluginBase.java index b7ad15816..610166132 100644 --- a/src/org/aavso/tools/vstar/plugin/ObservationToolPluginBase.java +++ b/src/org/aavso/tools/vstar/plugin/ObservationToolPluginBase.java @@ -48,6 +48,14 @@ abstract public class ObservationToolPluginBase implements IPlugin { */ abstract public void invoke(ISeriesInfoProvider seriesInfo); + /** + * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName() + */ + @Override + public String getDocName() { + return null; + } + /** * @see org.aavso.tools.vstar.plugin.IPlugin#getGroup() */ diff --git a/src/org/aavso/tools/vstar/plugin/ObservationTransformerPluginBase.java b/src/org/aavso/tools/vstar/plugin/ObservationTransformerPluginBase.java index 12de9ae3f..dfb7c06ff 100644 --- a/src/org/aavso/tools/vstar/plugin/ObservationTransformerPluginBase.java +++ b/src/org/aavso/tools/vstar/plugin/ObservationTransformerPluginBase.java @@ -46,6 +46,14 @@ abstract public class ObservationTransformerPluginBase implements IPlugin { abstract public IUndoableAction createAction( ISeriesInfoProvider seriesInfo, Set series); + /** + * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName() + */ + @Override + public String getDocName() { + return null; + } + /** * @see org.aavso.tools.vstar.plugin.IPlugin#getGroup() */ diff --git a/src/org/aavso/tools/vstar/plugin/period/PeriodAnalysisPluginBase.java b/src/org/aavso/tools/vstar/plugin/period/PeriodAnalysisPluginBase.java index 49115ca45..b35a3c9f6 100644 --- a/src/org/aavso/tools/vstar/plugin/period/PeriodAnalysisPluginBase.java +++ b/src/org/aavso/tools/vstar/plugin/period/PeriodAnalysisPluginBase.java @@ -78,6 +78,14 @@ public void sendPeriodChangeMessage(double period) { @Override abstract public String getDescription(); + /** + * @see org.aavso.tools.vstar.plugin.IPlugin#getDocName() + */ + @Override + public String getDocName() { + return null; + } + /** * @see org.aavso.tools.vstar.plugin.IPlugin#getGroup() */ diff --git a/src/org/aavso/tools/vstar/ui/MenuBar.java b/src/org/aavso/tools/vstar/ui/MenuBar.java index f7c05cfc7..6bd13a30a 100644 --- a/src/org/aavso/tools/vstar/ui/MenuBar.java +++ b/src/org/aavso/tools/vstar/ui/MenuBar.java @@ -1288,7 +1288,7 @@ public void actionPerformed(ActionEvent e) { public ActionListener createHelpContentsListener() { return new ActionListener() { public void actionPerformed(ActionEvent e) { - openHelpURLInWebBrowser("https://github.com/AAVSO/VStar/blob/master/doc/user_manual/VStarUserManual.pdf"); + Mediator.openHelpURLInWebBrowser("https://github.com/AAVSO/VStar/blob/master/doc/user_manual/VStarUserManual.pdf"); } }; } @@ -1299,11 +1299,12 @@ public void actionPerformed(ActionEvent e) { public ActionListener createVStarOnlineListener() { return new ActionListener() { public void actionPerformed(ActionEvent e) { - openHelpURLInWebBrowser("https://www.aavso.org/vstar-overview"); + Mediator.openHelpURLInWebBrowser("https://www.aavso.org/vstar-overview"); } }; } + /* Moved to Mediator private void openHelpURLInWebBrowser(final String urlStr) { javax.swing.SwingUtilities.invokeLater(new Runnable() { public void run() { @@ -1333,6 +1334,7 @@ public void run() { } }); } + */ /** * Returns the action listener to be invoked for Help->About... diff --git a/src/org/aavso/tools/vstar/ui/dialog/plugin/manager/PluginManagementDialog.java b/src/org/aavso/tools/vstar/ui/dialog/plugin/manager/PluginManagementDialog.java index 2fd58690c..aa864dfe0 100644 --- a/src/org/aavso/tools/vstar/ui/dialog/plugin/manager/PluginManagementDialog.java +++ b/src/org/aavso/tools/vstar/ui/dialog/plugin/manager/PluginManagementDialog.java @@ -25,6 +25,8 @@ import java.awt.event.ActionListener; import java.awt.event.WindowAdapter; import java.awt.event.WindowEvent; +import java.net.URLEncoder; +import java.nio.charset.StandardCharsets; import java.util.HashSet; import java.util.LinkedHashSet; import java.util.Set; @@ -66,6 +68,7 @@ public class PluginManagementDialog extends JDialog implements ListSelectionList private JButton updateButton; private JButton deleteButton; private JCheckBox allCheckBox; + private JButton helpButton; private JButton closeProgramButton; private final String DIALOG_TITLE = "Plug-in Manager"; @@ -91,6 +94,7 @@ public PluginManagementDialog(PluginManager manager) { topPane.setLayout(new BoxLayout(topPane, BoxLayout.PAGE_AXIS)); topPane.setBorder(BorderFactory.createEmptyBorder(5, 5, 5, 5)); + topPane.add(createURLpane(PluginManager.getPluginsBaseUrl())); topPane.add(createListPane()); topPane.add(createButtonPane()); topPane.add(createButtonPane2()); @@ -146,6 +150,13 @@ private void setRestartFlag() { pack(); } + private JPanel createURLpane(String pluginBaseURL) { + JPanel panel = new JPanel(); + JLabel label = new JLabel(pluginBaseURL); + panel.add(label); + return panel; + } + private JPanel createListPane() { JPanel panel = new JPanel(); panel.setBorder(BorderFactory.createEmptyBorder(5, 5, 5, 5)); @@ -211,6 +222,10 @@ private JPanel createButtonPane() { }); panel.add(allCheckBox); + helpButton = new JButton("Help"); + helpButton.addActionListener(createHelpButtonListener()); + panel.add(helpButton); + this.getRootPane().setDefaultButton(dismissButton); return panel; @@ -453,6 +468,24 @@ public void run() { }; } + // Return a listener for the "Help" button. + private ActionListener createHelpButtonListener() { + return new ActionListener() { + public void actionPerformed(ActionEvent e) { + String urlStr = "https://github.com/AAVSO/VStar/tree/master/plugin/doc/"; + if (!allCheckBox.isSelected()) { + int index = pluginList.getSelectedIndex(); + String description = (String)(pluginListModel.get(index)); + String plugin_doc_name = manager.getPluginDocName(description); + if (plugin_doc_name != null) { + urlStr += URLEncoder.encode(plugin_doc_name, StandardCharsets.UTF_8).replace("+", "%20"); + } + } + Mediator.openHelpURLInWebBrowser(urlStr); + } + }; + } + // Return a listener for the "Close Program" button. private ActionListener createCloseProgramButtonListener() { return new ActionListener() { diff --git a/src/org/aavso/tools/vstar/ui/dialog/plugin/manager/PluginManager.java b/src/org/aavso/tools/vstar/ui/dialog/plugin/manager/PluginManager.java index 24910b4c0..61b47674b 100644 --- a/src/org/aavso/tools/vstar/ui/dialog/plugin/manager/PluginManager.java +++ b/src/org/aavso/tools/vstar/ui/dialog/plugin/manager/PluginManager.java @@ -43,6 +43,7 @@ import org.aavso.tools.vstar.ui.VStar; import org.aavso.tools.vstar.ui.dialog.MessageBox; import org.aavso.tools.vstar.ui.resources.ResourceAccessor; +import org.aavso.tools.vstar.util.Pair; /** * This class manages plug-in installation, deletion, and update. @@ -92,6 +93,11 @@ public enum Operation { */ private Map remoteDescriptions; + /** + * A mapping from description to remote plugin document names. + */ + private Map remoteDocNames; + /** * A mapping from plugin jar name to plugin files installed locally. */ @@ -101,6 +107,11 @@ public enum Operation { * A mapping from description to local plugin jar name. */ private Map localDescriptions; + + /** + * A mapping from description to local plugin document names. + */ + private Map localDocNames; /** * A mapping from plugin jar name to dependent library files available to be @@ -288,6 +299,17 @@ public Map> getLibs() { return libs; } + /** + * @return the plugin document name. + */ + public String getPluginDocName(String description) { + String doc_name = localDocNames.get(description); + if (doc_name == null || "".equals(doc_name)) { + doc_name = remoteDocNames.get(description); + } + return doc_name; + } + /** * Does the plugin description correspond to a remote plugin? * @@ -394,6 +416,7 @@ public void retrieveRemotePluginInfo(String baseUrlStr) { remotePlugins = new TreeMap(); remoteDescriptions = new TreeMap(); + remoteDocNames = new TreeMap(); libs = new TreeMap>(); libDescriptions = new TreeMap>(); libRefs = new HashMap(); @@ -473,6 +496,7 @@ public void run() { } String plugin_desc = null; + String plugin_doc = null; URL pluginUrl = null; String className = pluginJarFileName.replace(".jar", ""); try { @@ -489,7 +513,9 @@ public void run() { depLibs.add(libUrl); } } - plugin_desc = getPluginDescription(pluginUrl, className, depLibs); + Pair info = getPluginDescription(pluginUrl, className, depLibs); + plugin_desc = info.first; + plugin_doc = info.second; } catch (Exception e) { //MessageBox.showErrorDialog("Plug-in Manager", // "Error reading remote plug-in information: " + className + ".\nErrror:\n" + @@ -505,6 +531,7 @@ public void run() { } remoteDescriptions.put(plugin_desc, pluginJarFileName); + remoteDocNames.put(plugin_desc, plugin_doc); remotePlugins.put(pluginJarFileName, pluginUrl); // Store dependent libs, if any exist, by plugin key. @@ -586,6 +613,7 @@ public void retrieveLocalPluginInfo() { localPlugins = new TreeMap(); localDescriptions = new TreeMap(); + localDocNames = new TreeMap(); FilenameFilter jarFilter = new FilenameFilter() { public boolean accept(File dir, String name) { @@ -626,11 +654,14 @@ public boolean accept(File dir, String name) { // Load plugin, store mappings from jar name to plugin // file and description. String plugin_desc = null; + String plugin_doc = null; String pluginJarFileName = file.getName(); String className = pluginJarFileName.replace(".jar", ""); try { localPlugins.put(pluginJarFileName, file); - plugin_desc = getPluginDescription(file.toURI().toURL(), className, depLibs); + Pair info = getPluginDescription(file.toURI().toURL(), className, depLibs); + plugin_desc = info.first; + plugin_doc = info.second; } catch (Exception e) { //MessageBox.showErrorDialog("Plug-in Manager", // "Error reading local plugin information: " + className + ".\nError:\n" + @@ -645,7 +676,8 @@ public boolean accept(File dir, String name) { continue; } - localDescriptions.put(plugin_desc, pluginJarFileName); + localDescriptions.put(plugin_desc, pluginJarFileName); + localDocNames.put(plugin_desc, plugin_doc); } } if (errors.size() > 0) { @@ -959,7 +991,7 @@ private void copy(InputStream in, File file) throws IOException { } } - private String getPluginDescription(URL url, String className, List depLibs) + private Pair getPluginDescription(URL url, String className, List depLibs) throws IOException, ClassNotFoundException, InstantiationException, IllegalAccessException { List urlList = new ArrayList(); urlList.add(url); @@ -969,7 +1001,7 @@ private String getPluginDescription(URL url, String className, List depLibs try { Class clazz = loader.loadClass(className); IPlugin plugin = (IPlugin) clazz.newInstance(); - return plugin.getDescription(); + return new Pair(plugin.getDescription(), plugin.getDocName()); } finally { loader.close(); } diff --git a/src/org/aavso/tools/vstar/ui/mediator/Mediator.java b/src/org/aavso/tools/vstar/ui/mediator/Mediator.java index 139e9ec41..9d3975111 100644 --- a/src/org/aavso/tools/vstar/ui/mediator/Mediator.java +++ b/src/org/aavso/tools/vstar/ui/mediator/Mediator.java @@ -19,10 +19,13 @@ import java.awt.Component; import java.awt.Cursor; +import java.awt.Desktop; import java.awt.Dimension; import java.awt.print.PrinterException; import java.io.File; import java.io.IOException; +import java.net.MalformedURLException; +import java.net.URISyntaxException; import java.net.URL; import java.text.DateFormat; import java.util.ArrayList; @@ -2350,4 +2353,37 @@ public void quit() { // defer to Mediator. System.exit(0); } + + /** + * Open a help page. + */ + public static void openHelpURLInWebBrowser(final String urlStr) { + javax.swing.SwingUtilities.invokeLater(new Runnable() { + public void run() { + // Try to open the VStar online page in the default web + // browser. + if (Desktop.isDesktopSupported()) { + Desktop desktop = Desktop.getDesktop(); + URL url = null; + try { + url = new URL(urlStr); + if (desktop.isSupported(Desktop.Action.BROWSE)) { + try { + desktop.browse(url.toURI()); + } catch (IOException e) { + MessageBox.showErrorDialog("VStar Help", + "Error reading from '" + urlStr + "'"); + } catch (URISyntaxException e) { + MessageBox.showErrorDialog("VStar Help", + "Invalid address: '" + urlStr + "'"); + } + } + } catch (MalformedURLException e) { + MessageBox.showErrorDialog("VStar Help", "Invalid address."); + } + } + } + }); + } + }