Merge pull request #240 from luzpaz/typos-projectforge-business

Fix typos in projectforge-business directory

projectforge-business/src/main/java/de/micromata/hibernate/history/delta/DeltaSetCalculator.java

@@ -125,7 +125,7 @@ private static void checkProperties(Object entity, SessionFactory sf, Set<String
 
             // Try to determine the property type from either currentState or,
             // previousState... Side-note: if both are null, we cannot determine
-            // the propertyType, but thats OK as no change has occurred (null==null)
+            // the propertyType, but that's OK as no change has occurred (null==null)
             if (!isCurrentNull) {
                 propertyType = propertyCurrentState.getClass();
             } else if (!wasPreviousNull) {
@@ -148,7 +148,7 @@ private static void checkProperties(Object entity, SessionFactory sf, Set<String
     }
 
     /**
-     * General use DeltaSet caluclator.
+     * General use DeltaSet calculator.
      */
     public static DeltaSet calculateDeltaSet(Object entity, SessionFactory sf, Serializable entityId, Class<?> entityType,
                                              Object obj1,
@@ -370,7 +370,7 @@ private static boolean areEntitiesEqual(Object obj1, Object obj2, SessionFactory
         }
       }
     } catch (Exception ex) {
-      log.error("Exception occured:" + ex, ex);
+      log.error("Exception occurred:" + ex, ex);
     }*/
 
         return obj1.equals(obj2);

projectforge-business/src/main/java/org/projectforge/ProjectForgeApp.java

@@ -267,15 +267,15 @@ public void internalSetUpAndRunning(final boolean upAndRunning) {
     }
 
     /**
-     * @return True, if the dest file exists or was created successfully. False if an error while creation occured.
+     * @return True, if the dest file exists or was created successfully. False if an error while creation occurred.
      */
     public static boolean ensureInitialConfigFile(String classPathSourceFilename, String destFilename) {
         String baseDir = System.getProperty(ProjectForgeApp.CONFIG_PARAM_BASE_DIR);
         return ensureInitialConfigFile(new File(baseDir), classPathSourceFilename, destFilename, true, null);
     }
 
     /**
-     * @return True, if the dest file exists or was created successfully. False if an error while creation occured.
+     * @return True, if the dest file exists or was created successfully. False if an error while creation occurred.
      */
     public static boolean ensureInitialConfigFile(File baseDir, String classPathSourceFilename, String destFilename, boolean logEnabled, StringModifier modifier) {
         if (junitTestMode)

projectforge-business/src/main/java/org/projectforge/business/excel/ContentProvider.java

@@ -115,7 +115,7 @@ public interface ContentProvider
   public ContentProvider setColWidths(int... charLengths);
 
   /**
-   * Creates a new instance. This is usefull because every sheet of the workbook should have its own content provider (regarding col widths,
+   * Creates a new instance. This is useful because every sheet of the workbook should have its own content provider (regarding col widths,
    * property formats etc.) if not set explicit.
    *
    * @return

projectforge-business/src/main/java/org/projectforge/business/fibu/MonthlyEmployeeReport.java

@@ -201,7 +201,7 @@ public static String getFormattedDuration(final long duration) {
     }
 
     /**
-     * Dont't forget to initialize: setFormatter and setUser or setEmployee.
+     * Don't forget to initialize: setFormatter and setUser or setEmployee.
      *
      * @param year
      * @param month 1-based: 1 - January, ..., 12 - December

projectforge-business/src/main/java/org/projectforge/business/fibu/OldKostFormatter.java

@@ -205,7 +205,7 @@ public static String format(final Kost2DO kost2, final boolean numberFormat) {
    * <li>Project is given: [description]; [projekt.kunde.name] - [projekt.name]; [kost2Art.id] - [kost2Art.name];</li>
    * <li>Project is not given: [description]</li>
    * </ul>
-   * DONT'T forget to escape html if displayed directly!
+   * DON'T forget to escape html if displayed directly!
    *
    * @param kost2
    * @return formatted string or "" if kost2 is null.

projectforge-business/src/main/java/org/projectforge/business/fibu/SEPATransferGenerator.java

@@ -120,7 +120,7 @@ public SEPATransferResult format(final List<EingangsrechnungDO> invoices) {
         final SEPATransferResult result = new SEPATransferResult();
 
         if (this.jaxbContext == null || invoices == null || invoices.isEmpty()) {
-            String errorPrefix = "A problem accured while exporting invoices: ";
+            String errorPrefix = "A problem occurred while exporting invoices: ";
             String error = "";
             // if jaxb context is missing, generation is not possible
             if (this.jaxbContext == null) {
@@ -155,7 +155,7 @@ public SEPATransferResult format(final List<EingangsrechnungDO> invoices) {
         try {
             grpHdr.setCreDtTm(DatatypeFactory.newInstance().newXMLGregorianCalendar(gc));
         } catch (DatatypeConfigurationException e) {
-            log.error("Exception occured while setting creDtTm property.", e);
+            log.error("Exception occurred while setting creDtTm property.", e);
         }
         grpHdr.setNbOfTxs(String.valueOf(invoices.size()));
         final PartyIdentificationSEPA1 partyIdentificationSEPA1 = factory.createPartyIdentificationSEPA1();
@@ -175,7 +175,7 @@ public SEPATransferResult format(final List<EingangsrechnungDO> invoices) {
         try {
             pmtInf.setReqdExctnDt(DatatypeFactory.newInstance().newXMLGregorianCalendar(gc));
         } catch (DatatypeConfigurationException e) {
-            log.error("Exception occured while setting reqdExctnDt property.", e);
+            log.error("Exception occurred while setting reqdExctnDt property.", e);
         }
         // pmtInf.setChrgBr(ChargeBearerTypeSEPACode.SLEV); // TODO check if this is required
 

projectforge-business/src/main/java/org/projectforge/business/gantt/GanttChart.java

@@ -282,7 +282,7 @@ public Document create() {
     g2.appendChild(g3);
     // diagram.appendChild(SVGHelper.createUse(doc, "#diamond", 100, 15.5 * style.getYScale()));
     // diagram.appendChild(SVGHelper.createRect(doc, 110, 15 * style.getYScale() + 2, 140, 16, "white"));
-    // diagram.appendChild(SVGHelper.createText(doc, 110, 15.5 * style.getYScale() + 5, "This is a nonsens milestone.", "fill", "gray",
+    // diagram.appendChild(SVGHelper.createText(doc, 110, 15.5 * style.getYScale() + 5, "This is a nonsense milestone.", "fill", "gray",
     // "font-size", "8pt"));
 
     g1 = SVGHelper.createElement(doc, "g", "transform", "translate(265,65)");

projectforge-business/src/main/java/org/projectforge/business/ldap/LdapConnector.java

@@ -121,7 +121,7 @@ public LdapContext createContext() {
       final LdapContext ctx = new InitialLdapContext(env, null);
       return ctx;
     } catch (final NamingException ex) {
-      log.error("While trying to connect LDAP initally: " + ex.getMessage(), ex);
+      log.error("While trying to connect LDAP initially: " + ex.getMessage(), ex);
       throw new RuntimeException(ex);
     }
   }

projectforge-business/src/main/java/org/projectforge/business/ldap/LdapMasterLoginHandler.java

@@ -107,7 +107,7 @@ public LoginResult checkLogin(final String username, final char[] password) {
         ldapUserDao.changePassword(ldapUser, null, password); // update the userPassword but not the (WLAN)sambaNTPassword
       }
     } catch (final Exception ex) {
-      log.error("An exception occured while checking login against LDAP system (ignoring this error): " + ex.getMessage(), ex);
+      log.error("An exception occurred while checking login against LDAP system (ignoring this error): " + ex.getMessage(), ex);
     }
     return loginResult;
   }

projectforge-business/src/main/java/org/projectforge/business/ldap/MyTrustManager.java

@@ -127,7 +127,7 @@ public void checkServerTrusted(final X509Certificate[] chain, final String authT
       try {
         chain[0].verify(certificate.getPublicKey());
         for (final X509Certificate cert : chain) {
-          // Verifing by public key
+          // Verifying by public key
           cert.checkValidity();
         }
       } catch (final InvalidKeyException | SignatureException | NoSuchAlgorithmException | NoSuchProviderException ex) {

projectforge-business/src/main/java/org/projectforge/business/orga/ContractDao.java

@@ -121,7 +121,7 @@ public void onInsertOrModify(final ContractDO obj, final OperationType operation
     /**
      * Gets the highest contract number.
      *
-     * @param contract is needed to check wether the contract does already exist or not. If already exist it will be
+     * @param contract is needed to check whether the contract does already exist or not. If already exist it will be
      *                 assured that this contract has an unchanged number.
      */
     @SuppressWarnings("unchecked")

projectforge-business/src/main/java/org/projectforge/business/task/TaskNode.java

@@ -344,7 +344,7 @@ void setParent(final TaskNode parent) {
   }
 
   /**
-   * Adds a new task as a child of this node. It does not check wether this task already exist as child or not! This
+   * Adds a new task as a child of this node. It does not check whether this task already exist as child or not! This
    * method does not modify the child task!
    */
   void addChild(final TaskNode child) {

projectforge-business/src/main/java/org/projectforge/business/task/TaskTree.kt

@@ -697,7 +697,7 @@ class TaskTree : AbstractCache(TICKS_PER_HOUR),
     /**
      * @param node
      * @return The ordered person days or if not found the defined max hours. If both not found, the get the sum of all
-     * diect or null if both not found.
+     * direct or null if both not found.
      */
     fun getPersonDays(node: TaskNode?): BigDecimal? {
         checkRefresh()

projectforge-business/src/main/java/org/projectforge/business/task/TaskTreeHelper.java

@@ -26,7 +26,7 @@
 import org.projectforge.business.task.TaskTree;
 
 /**
- * For backward compability, please use TaskTree as autowired member instead.
+ * For backward compatibility, please use TaskTree as autowired member instead.
  * @author Kai Reinhard ([email protected])
  */
 public class TaskTreeHelper {

projectforge-business/src/main/java/org/projectforge/business/teamcal/event/ical/EventHandleError.java

@@ -28,7 +28,7 @@ public enum EventHandleError
   CALANDER_NOT_SPECIFIED,               // no calender defined
   NO_METHOD_SELECTED,                   // no method for handling event selected
 
-  WARN_MAIN_RECURRING_EVENT_MISSING,    // the main event of an reccurring one is missing
+  WARN_MAIN_RECURRING_EVENT_MISSING,    // the main event of a recurring one is missing
   WARN_EVENT_TO_DELETE_NOT_FOUND,       // No event in db to delete
   WARN_OUTDATED                         // the parsed event is older then the current DB state
 }

projectforge-business/src/main/java/org/projectforge/business/teamcal/event/right/TeamEventRight.java

@@ -133,7 +133,7 @@ public boolean hasDeleteAccess(final PFUserDO user, final TeamEventDO obj, final
   }
 
   /**
-   * Owners of the given calendar and users with full access hav update access to the given calendar: obj.getCalendar().
+   * Owners of the given calendar and users with full access have update access to the given calendar: obj.getCalendar().
    *
    * @see org.projectforge.business.user.UserRightAccessCheck#hasUpdateAccess(org.projectforge.framework.persistence.user.entities.PFUserDO,
    *      java.lang.Object, java.lang.Object)

projectforge-business/src/main/java/org/projectforge/business/teamcal/servlet/TeamCalResponseServlet.java

@@ -179,7 +179,7 @@ protected void doGet(final HttpServletRequest req, final HttpServletResponse res
 
     resp.setContentType("text/html;charset=UTF-8");
     final Map<String, Object> templateData = new HashMap<>();
-    templateData.put("reponse", I18nHelper.getLocalizedMessage("plugins.teamcal.attendee.response." + statusFinal.getKey()));
+    templateData.put("response", I18nHelper.getLocalizedMessage("plugins.teamcal.attendee.response." + statusFinal.getKey()));
     final String content = renderGroovyTemplate("htmlTemplates/teamEventResponse.html", templateData);
 
     resp.getOutputStream().print(content);
@@ -189,7 +189,7 @@ private void sendNotValidData(HttpServletResponse resp) throws IOException
   {
     resp.setContentType("text/html;charset=UTF-8");
     final Map<String, Object> templateData = new HashMap<>();
-    templateData.put("reponse", I18nHelper.getLocalizedMessage("plugins.teamcal.attendee.response.error"));
+    templateData.put("response", I18nHelper.getLocalizedMessage("plugins.teamcal.attendee.response.error"));
     final String content = renderGroovyTemplate("htmlTemplates/teamEventResponse.html", templateData);
     resp.getOutputStream().print(content);
   }

projectforge-business/src/main/java/org/projectforge/business/user/UserXmlPreferencesBaseDOSingleValueConverter.java

@@ -91,7 +91,7 @@ public Object fromString(final String str)
     final Long id = Long.parseLong(str);
     final BaseDao<?> dao = applicationContext.getBean(daoClass);
     if (dao == null) {
-      log.error("Could not get dao '" + daoClass + "'. It's not registerd in the Registry.");
+      log.error("Could not get dao '" + daoClass + "'. It's not registered in the Registry.");
       return null;
     } else {
       return dao.findOrLoad(id);

projectforge-business/src/main/java/org/projectforge/business/user/service/UserXmlPreferencesService.java

@@ -113,7 +113,7 @@ public <T> T getEntry(Class<T> expectedType, String key) {
         if (expectedType.isAssignableFrom(entry.getClass())) {
             return (T) entry;
         }
-        // Probably a new software release results in an incompability of old and new object format.
+        // Probably a new software release results in an incompatibility of old and new object format.
         log.info("Could not get user preference entry: (old) type "
                 + entry.getClass().getName()
                 + " is not assignable to (new) required type "

projectforge-business/src/main/java/org/projectforge/business/utils/HtmlTagBuilder.java

@@ -97,7 +97,7 @@ public void addAttribute(String name, String value)
   }
 
   /**
-   * Appends '>' character for closing the start tag. Only useable in quick and dirty mode. Otherwise a
+   * Appends '>' character for closing the start tag. Only usable in quick and dirty mode. Otherwise a
    * NullPointerException will be thrown.
    */
   public void finishStartTag()
@@ -106,7 +106,7 @@ public void finishStartTag()
   }
 
   /**
-   * Appends " />" character for closing the start tag. Only useable in quick and dirty mode. Otherwise a
+   * Appends " />" character for closing the start tag. Only usable in quick and dirty mode. Otherwise a
    * NullPointerException will be thrown.
    */
   public void finishEmptyTag()

projectforge-business/src/main/java/org/projectforge/framework/cache/AbstractCache.java

@@ -24,7 +24,7 @@
 package org.projectforge.framework.cache;
 
 /**
- * This class is usefull, if the stored object of derived classes has to be cached. After reaching expireTime during a
+ * This class is useful, if the stored object of derived classes has to be cached. After reaching expireTime during a
  * request, the method refresh will be called.
  *
  * @author Kai Reinhard ([email protected])

projectforge-business/src/main/java/org/projectforge/framework/configuration/ConfigXml.java

@@ -502,7 +502,7 @@ public String getApplicationHomeDir() {
      * don't configure this element, you will receive the standard ProjectForge menu containing all menu entries which are
      * available for the system and the user. <br/>
      * Please note: ProjectForge assures, that only such menu entries are visible, to which the user has the access to
-     * (independant from your definitions here)! <br/>
+     * (independent from your definitions here)! <br/>
      * If you want to make a menu entry invisible, you can add this to this root element like this:<br/>
      *
      * <pre>

projectforge-business/src/main/java/org/projectforge/framework/configuration/ConfigurationType.java

@@ -26,7 +26,7 @@
 public enum ConfigurationType
 {
   STRING, TEXT, LONG, INTEGER, FLOAT, BOOLEAN, PERCENT,
-  /** TASK only for backward compability. Isn't in use anymore. */
+  /** TASK only for backward compatibility. Isn't in use anymore. */
   TASK,
   TIME_ZONE, CALENDAR;
 

projectforge-business/src/main/java/org/projectforge/framework/configuration/PFSpringConfiguration.java

@@ -44,7 +44,7 @@
 import javax.sql.DataSource;
 
 /**
- * Intial spring configuration for ProjectForge.
+ * Initial spring configuration for ProjectForge.
  *
  * @author Florian Blumenstein, Roger Rene Kommer ([email protected])
  */

projectforge-business/src/main/java/org/projectforge/framework/persistence/api/SearchDao.java

@@ -54,7 +54,7 @@ public List<SearchResultData> getEntries(final BaseSearchFilter filter, final Cl
     }
     final List<ExtendedBaseDO> list = baseDao.selectForSearchDao(filter);
     if (list == null) {
-      // An error occured.
+      // An error occurred.
       return null;
     }
     final List<SearchResultData> result = new ArrayList<>();

projectforge-business/src/main/java/org/projectforge/framework/persistence/api/SearchResultData.java

@@ -45,7 +45,7 @@ public ExtendedBaseDO<Integer> getDataObject()
   }
 
   /**
-   * History entriy of the object for the search result.
+   * History entry of the object for the search result.
    */
   public HistoryEntry getHistoryEntry()
   {

projectforge-business/src/main/java/org/projectforge/framework/renderer/PdfRenderer.java

@@ -49,7 +49,7 @@
 /**
  * This class provides the functionality for rendering pdf files. The underlaying technology is XSL-FO. The dynamic data
  * will be given in xml format and the transformation will be done via xslt-scripts. For a better ease of use a meta
- * language similiar to html will be used instead of plain xsl-fo. The html file with jelly script elements will be
+ * language similar to html will be used instead of plain xsl-fo. The html file with jelly script elements will be
  * rendered via xslt-scripts into xsl-fo and afterwards to pdf.
  *
  * @author Kai Reinhard ([email protected])

projectforge-business/src/main/java/org/projectforge/framework/time/DateHelper.java

@@ -230,7 +230,7 @@ public static Date parseMillis(final String str) {
 
   /**
    * @param str
-   * @param logError If true, any ParseException error will be logged if occured.
+   * @param logError If true, any ParseException error will be logged if occurred.
    * @return The parsed date or null, if not parseable.
    */
   public static Date parseMillis(final String str, final boolean logError) {

projectforge-business/src/main/java/org/projectforge/framework/utils/CloneHelper.java

@@ -37,7 +37,7 @@ public class CloneHelper
 
   /**
    * Serialized the given object as ByteArray and deserializes it.
-   * @param orgin
+   * @param origin
    * @return
    */
   @SuppressWarnings("unchecked")

projectforge-business/src/main/java/org/projectforge/framework/utils/FileHelper.java

@@ -58,7 +58,7 @@ public static String getAbsolutePath(String parent, String path)
 
   /**
    * Creates a safe filename from the given string by converting all non specified characters will replaces by an underscore or will be
-   * substitue. Example: "Schrödinger" -> "Schroedinger", "http://www.micromata.de" -> "http_www.micromata.de".
+   * substitute. Example: "Schrödinger" -> "Schroedinger", "http://www.micromata.de" -> "http_www.micromata.de".
    * 
    * @param str
    * @param maxlength The maximum length of the result.

projectforge-business/src/main/java/org/projectforge/framework/utils/KeyValuePairWriter.java

@@ -91,7 +91,7 @@ public KeyValuePairWriter write(final String key, final Date value)
   }
 
   /**
-   * Appends the given value. The string will be encapsulated in quotation marks: " Any occurance of the quotation mark will be quoted by
+   * Appends the given value. The string will be encapsulated in quotation marks: " Any occurrence of the quotation mark will be quoted by
    * duplication. Example: hallo -> "hallo", hal"lo -> "hal""lo"
    * 
    * @param value The value to append.

projectforge-business/src/main/java/org/projectforge/framework/xmlstream/ProjectForgeRootElement.java

@@ -30,7 +30,7 @@
 import java.util.TimeZone;
 
 /**
- * For export and import it's usefull to use an instance of this object to define for example the time zone, version etc.
+ * For export and import it's useful to use an instance of this object to define for example the time zone, version etc.
  * @author Kai Reinhard ([email protected])
  *
  */

projectforge-business/src/main/java/org/projectforge/registry/Registry.java

@@ -165,7 +165,7 @@ private RegistryEntry register(final String id, final Class<? extends BaseDao<?>
         }
         final RegistryEntry entry = new RegistryEntry(id, daoClassType, dao, i18nPrefix);
         register(entry);
-        log.debug("Dao '" + id + "' registerd.");
+        log.debug("Dao '" + id + "' registered.");
         return entry;
     }
 

projectforge-business/src/main/java/org/projectforge/web/session/UserAgentBrowser.java

@@ -42,7 +42,7 @@ public boolean isIn(final UserAgentBrowser... browser)
   public static UserAgentBrowser getBrowserFromUserAgentString(String userAgent)
   {
     if (StringUtils.isNotEmpty(userAgent)) {
-      //TODO: Add mor browsers for user agent
+      //TODO: Add more browsers for user agent
       if (userAgent.contains("Version")) {
         return UserAgentBrowser.SAFARI;
       }

projectforge-business/src/main/kotlin/org/projectforge/business/address/AddressDO.kt

@@ -273,7 +273,7 @@ open class AddressDO : DefaultBaseDO(), DisplayNameCapable {
     open var birthday: LocalDate? = null
 
     /**
-     * Time stamp of last image modification (or deletion). Usefull for history of changes.
+     * Time stamp of last image modification (or deletion). Useful for history of changes.
      */
     @get:Column(name = "image_last_update")
     open var imageLastUpdate: Date? = null

projectforge-business/src/main/kotlin/org/projectforge/business/address/AddressbookCache.kt

@@ -56,7 +56,7 @@ open class AddressbookCache : AbstractCache() {
 
     private var addressBookList = listOf<AddressbookDO>() // Mustn't be synchronized, it's only read.
 
-    // key is the addres.id, value is a set of addressbook's assigned to the address.
+    // key is the address.id, value is a set of addressbook's assigned to the address.
     private var addressBookByAddressMap = mapOf<Long, List<AddressbookDO>>() // Mustn't be synchronized, it's only read.
 
     fun getAll(): List<AddressbookDO> {