performed javacscript:fix and worked on documentation

[taxeditor.git] / taxeditor-store / src / main / java / eu / etaxonomy / taxeditor / datasource / wizard / CdmDataSourceCredentialsWizardPage.java

diff --git a/taxeditor-store/src/main/java/eu/etaxonomy/taxeditor/datasource/wizard/CdmDataSourceCredentialsWizardPage.java b/taxeditor-store/src/main/java/eu/etaxonomy/taxeditor/datasource/wizard/CdmDataSourceCredentialsWizardPage.java
index ffb3abb80d289c8499d774691c9b12efb310d4dd..1d3e754449c3482584d0313f6c828a6e30db479a 100644 (file)
--- a/taxeditor-store/src/main/java/eu/etaxonomy/taxeditor/datasource/wizard/CdmDataSourceCredentialsWizardPage.java
+++ b/taxeditor-store/src/main/java/eu/etaxonomy/taxeditor/datasource/wizard/CdmDataSourceCredentialsWizardPage.java
@@ -36,6 +36,8 @@ import eu.etaxonomy.taxeditor.preference.PreferencesUtil;
 
 
 /**
+ * <p>Abstract CdmDataSourceCredentialsWizardPage class.</p>
+ *
  * @author n.hoffmann
  * @created 19.05.2009
  * @version 1.0
@@ -63,7 +65,9 @@ public abstract class CdmDataSourceCredentialsWizardPage extends WizardPage impl
        protected NomenclaturalCode nomenclaturalCode;
        
        /**
-        * @param pageName
+        * <p>Constructor for CdmDataSourceCredentialsWizardPage.</p>
+        *
+        * @param pageName a {@link java.lang.String} object.
         */
        protected CdmDataSourceCredentialsWizardPage(String pageName) {
                super(pageName);
@@ -73,6 +77,7 @@ public abstract class CdmDataSourceCredentialsWizardPage extends WizardPage impl
        /* (non-Javadoc)
         * @see org.eclipse.jface.dialogs.IDialogPage#createControl(org.eclipse.swt.widgets.Composite)
         */
+       /** {@inheritDoc} */
        public void createControl(Composite parent) {
                this.parent = parent;
                
@@ -121,6 +126,9 @@ public abstract class CdmDataSourceCredentialsWizardPage extends WizardPage impl
                init();
        }
 
+       /**
+        * <p>createAuthenticationForm</p>
+        */
        protected void createAuthenticationForm(){
                // Create group composite for authentication data
                authenticationGroup = new Group(composite, SWT.NONE);
@@ -186,10 +194,8 @@ public abstract class CdmDataSourceCredentialsWizardPage extends WizardPage impl
        
        
        /**
-        * Tries to open a connection to the given dataSource. Generates a message on either 
-        * failure or success 
-        * 
-        * @param dataSource
+        * Tries to open a connection to the given dataSource. Generates a message on either
+        * failure or success
         */
        public void testDbConfiguration(){
                try{
@@ -209,10 +215,19 @@ public abstract class CdmDataSourceCredentialsWizardPage extends WizardPage impl
         */
        public abstract void createDatabaseForm(); 
        
+       /**
+        * <p>updateLocation</p>
+        */
        public abstract void updateLocation();
        
+       /**
+        * <p>updateDataSource</p>
+        */
        public abstract void updateDataSource();
        
+       /**
+        * <p>checkPageComplete</p>
+        */
        public void checkPageComplete(){
                boolean complete = database.length() != 0;
 //             complete &= username.length() != 0;
@@ -221,7 +236,7 @@ public abstract class CdmDataSourceCredentialsWizardPage extends WizardPage impl
        }
        
        /**
-        * Initialize text fields 
+        * Initialize text fields
         */
        public void init() {
                if(getDataSource() != null){
@@ -244,12 +259,15 @@ public abstract class CdmDataSourceCredentialsWizardPage extends WizardPage impl
        /* (non-Javadoc)
         * @see org.eclipse.jface.wizard.WizardPage#getNextPage()
         */
+       /** {@inheritDoc} */
        @Override
        public IWizardPage getNextPage() {
                return null;
        }
 
        /**
+        * <p>Setter for the field <code>dataSource</code>.</p>
+        *
         * @param dataSource the dataSource to set
         */
        public void setDataSource(ICdmDataSource dataSource) {
@@ -257,6 +275,8 @@ public abstract class CdmDataSourceCredentialsWizardPage extends WizardPage impl
        }
 
        /**
+        * <p>Getter for the field <code>dataSource</code>.</p>
+        *
         * @return the dataSource
         */
        public ICdmDataSource getDataSource() {
@@ -264,7 +284,9 @@ public abstract class CdmDataSourceCredentialsWizardPage extends WizardPage impl
        }
        
        /**
-        * @return
+        * <p>getDataSourceName</p>
+        *
+        * @return a {@link java.lang.String} object.
         */
        public String getDataSourceName() {
                if(dataSource instanceof CdmPersistentDataSource){
@@ -276,6 +298,7 @@ public abstract class CdmDataSourceCredentialsWizardPage extends WizardPage impl
        /* (non-Javadoc)
         * @see org.eclipse.swt.events.ModifyListener#modifyText(org.eclipse.swt.events.ModifyEvent)
         */
+       /** {@inheritDoc} */
        public void modifyText(ModifyEvent e) {
                updateLocation();
                updateAuthentication();
@@ -284,10 +307,11 @@ public abstract class CdmDataSourceCredentialsWizardPage extends WizardPage impl
        }       
        
        /**
-        * 
-        * @param text  
-        * @param listener
-        * @param string
+        * <p>modifyTextWithoutTriggeringListeners</p>
+        *
+        * @param text a {@link org.eclipse.swt.widgets.Text} object.
+        * @param listener a {@link org.eclipse.swt.events.ModifyListener} object.
+        * @param string a {@link java.lang.String} object.
         */
        protected void modifyTextWithoutTriggeringListeners(Text text, ModifyListener listener, String string){
                text.removeModifyListener(listener);