Package org.cesilko.rachota.core

Class RegularTasksScanner

  • public class RegularTasksScanner
extends java.lang.Object
    This is a DOM tree scanner of regular tasks plan XML files.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      (package private) org.w3c.dom.Document document
      XML document that is being loaded.
      private static java.lang.String dtd
      String holding whole content of regular_tasks.dtd validation file.

    • Constructor Summary

      Constructors 
      Constructor Description
      RegularTasksScanner​(org.w3c.dom.Document document)
      Creates new regular tasks scanner.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static void createDTD()
      Creates regular_tasks.dtd file that is used for automatic XML validation of regular tasks plan files.
      private boolean loadAutomaticStart​(org.w3c.dom.Element notificationElement)
      Loads automatic start option from given XML element.
      private java.lang.String loadDescription​(org.w3c.dom.Element descriptionElement)
      Loads description from given XML element.
      void loadDocument()
      Loads XML regular tasks document given in the scanner constructor.
      private java.lang.String loadKeyword​(org.w3c.dom.Element keywordElement)
      Loads keyword from given XML element.
      private java.lang.String loadNotes​(org.w3c.dom.Element notesElement)
      Loads notes from given XML element.
      private long loadNotification​(org.w3c.dom.Element notificationElement)
      Loads notification time from given XML element.
      private void loadPlan​(org.w3c.dom.Element element)
      Loads regular tasks plan from given XML element.
      private int loadPriority​(org.w3c.dom.Element priorityElement)
      Loads priority from given XML element.
      private void loadRegularTask​(org.w3c.dom.Element regularTaskElement)
      Loads regular task from given XML element.
      private int loadRepetition​(org.w3c.dom.Element repetitionElement)
      Loads repetition from given XML element.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • document

        org.w3c.dom.Document document
        XML document that is being loaded.

      • dtd

        private static java.lang.String dtd
        String holding whole content of regular_tasks.dtd validation file.

    • Constructor Detail

      • RegularTasksScanner

        public RegularTasksScanner​(org.w3c.dom.Document document)
        Creates new regular tasks scanner.
        Parameters:
        document - XML regular tasks document to be loaded.

    • Method Detail

      • loadDocument

        public void loadDocument()
        Loads XML regular tasks document given in the scanner constructor.

      • loadPlan

        private void loadPlan​(org.w3c.dom.Element element)
        Loads regular tasks plan from given XML element.
        Parameters:
        element - XML element representing a plan of regular tasks.

      • loadRegularTask

        private void loadRegularTask​(org.w3c.dom.Element regularTaskElement)
        Loads regular task from given XML element.
        Parameters:
        regularTaskElement - XML element representing a regular task.

      • loadPriority

        private int loadPriority​(org.w3c.dom.Element priorityElement)
        Loads priority from given XML element.
        Parameters:
        priorityElement - XML element representing a priority.
        Returns:
        Priority loaded from given XML element.

      • loadDescription

        private java.lang.String loadDescription​(org.w3c.dom.Element descriptionElement)
        Loads description from given XML element.
        Parameters:
        descriptionElement - XML element representing a description.
        Returns:
        Description loaded from given XML element.

      • loadKeyword

        private java.lang.String loadKeyword​(org.w3c.dom.Element keywordElement)
        Loads keyword from given XML element.
        Parameters:
        keywordElement - XML element representing a keyword.
        Returns:
        Keyword loaded from given XML element.

      • loadNotes

        private java.lang.String loadNotes​(org.w3c.dom.Element notesElement)
        Loads notes from given XML element.
        Parameters:
        notesElement - XML element representing a notes.
        Returns:
        Notes loaded from given XML element.

      • loadNotification

        private long loadNotification​(org.w3c.dom.Element notificationElement)
        Loads notification time from given XML element.
        Parameters:
        notificationElement - XML element representing a notification time.
        Returns:
        Notification time loaded from given XML element.

      • loadAutomaticStart

        private boolean loadAutomaticStart​(org.w3c.dom.Element notificationElement)
        Loads automatic start option from given XML element.
        Parameters:
        notificationElement - XML element representing a notification time.
        Returns:
        Automatic start option loaded from given XML element.

      • loadRepetition

        private int loadRepetition​(org.w3c.dom.Element repetitionElement)
        Loads repetition from given XML element.
        Parameters:
        repetitionElement - XML element representing a repetition.
        Returns:
        Repetition loaded from given XML element.

      • createDTD

        public static void createDTD()
        Creates regular_tasks.dtd file that is used for automatic XML validation of regular tasks plan files.