From d180bdcc547bc11a6c9b497e80fdf3b856c9ef9e Mon Sep 17 00:00:00 2001 From: Arvind Sasikumar Date: Wed, 29 Mar 2017 22:35:56 +0530 Subject: [PATCH 1/4] Update README.md --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 7be5346..b63d30c 100644 --- a/README.md +++ b/README.md @@ -62,3 +62,10 @@ public class Test{ } } ``` +Starting from v2.0, now you can set up database mapping using a custom markup language called the Database Mapping Markup Language (DMML). Once you have a dmml file, to get a DBMap object, simply call: + +```java +DBMap dbMap = DBMap.getDBMapFromFile("dmml_file_path"); +``` + +DMML file is very easy to generate. For help on generating a .dmml file, check out the DMMLGuide and sample.dmml. From 75d120d8b17ecfb6e42cdcad1b778aa97dec6237 Mon Sep 17 00:00:00 2001 From: Arvind Sasikumar Date: Wed, 29 Mar 2017 22:42:53 +0530 Subject: [PATCH 2/4] Add files via upload --- sample.dmml | 74 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 74 insertions(+) create mode 100644 sample.dmml diff --git a/sample.dmml b/sample.dmml new file mode 100644 index 0000000..dd17276 --- /dev/null +++ b/sample.dmml @@ -0,0 +1,74 @@ + + + + positions_server + + + positions_client + + + servertime + + + servertime + + + + servertime + + + servertime + + + STRING + + + + + latitude + + + latitude + + + NUMERICAL + + + + + + events + + + events + + + servertime + + + servertime + + + + eventname + + + eventname + + + STRING + + + + + servertime + + + servertime + + + STRING + + + + \ No newline at end of file From 25fe2fdae20c49a373c7529a53c49a45a3ed3be0 Mon Sep 17 00:00:00 2001 From: Arvind Sasikumar Date: Wed, 29 Mar 2017 22:48:28 +0530 Subject: [PATCH 3/4] Create DMMLGuide --- DMMLGuide | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 DMMLGuide diff --git a/DMMLGuide b/DMMLGuide new file mode 100644 index 0000000..d15acfa --- /dev/null +++ b/DMMLGuide @@ -0,0 +1,14 @@ +DMML has only x tags - + +1. : signals the start of the database map +2. : signals start of the table map +3. : when enclosed inside tags, it refers to the source table and when enclosed inside tags, it refers to the source attribute +4. : when enclosed inside tags, it refers to the destination table and when enclosed inside tags, it refers to the destination attribute +5. : refers to the source table's timestamp attribute +6. : refers to the source table's timestamp attribute +7. : signals start of an attribute map; always sits inside a table map +8. : type of attributes in a nattribute map, can only take two values, STRING and NUMERICAL (case-sensitive) + +Make sure to close all tags properly. Also, the tags themselves (both opening and closing separately) have to be written on a new line with the tag information in between them on a line of its own. + +For a complete understanding, check the sample.dmml file. From 5a8ea1715d18a28228572d89595df8c4a8694b11 Mon Sep 17 00:00:00 2001 From: Arvind Sasikumar Date: Wed, 29 Mar 2017 22:57:46 +0530 Subject: [PATCH 4/4] Add files via upload --- javadoc/allclasses-frame.html | 5 +- javadoc/allclasses-noframe.html | 5 +- javadoc/constant-values.html | 4 +- javadoc/deprecated-list.html | 4 +- javadoc/help-doc.html | 4 +- javadoc/index-files/index-1.html | 8 +- javadoc/index-files/index-10.html | 99 +++++-- javadoc/index-files/index-11.html | 125 +++++++++ javadoc/index-files/index-12.html | 135 ++++++++++ javadoc/index-files/index-2.html | 8 +- javadoc/index-files/index-3.html | 8 +- javadoc/index-files/index-4.html | 12 +- javadoc/index-files/index-5.html | 17 +- javadoc/index-files/index-6.html | 18 +- javadoc/index-files/index-7.html | 18 +- javadoc/index-files/index-8.html | 93 +------ javadoc/index-files/index-9.html | 24 +- javadoc/index.html | 2 +- javadoc/overview-tree.html | 13 +- javadoc/serialized-form.html | 127 +++++++++ javadoc/sync/db/mysql/AttributeMap.html | 4 +- javadoc/sync/db/mysql/AttributeType.html | 4 +- javadoc/sync/db/mysql/DBMap.html | 56 +++- .../sync/db/mysql/DBSyncAgent.Builder.html | 4 +- javadoc/sync/db/mysql/DBSyncAgent.html | 29 +- javadoc/sync/db/mysql/DBSynchronizer.html | 10 +- .../db/mysql/InvalidDBMapFileException.html | 249 ++++++++++++++++++ javadoc/sync/db/mysql/SyncType.html | 8 +- javadoc/sync/db/mysql/TableMap.html | 4 +- .../sync/db/mysql/class-use/AttributeMap.html | 4 +- .../db/mysql/class-use/AttributeType.html | 4 +- javadoc/sync/db/mysql/class-use/DBMap.html | 26 +- .../mysql/class-use/DBSyncAgent.Builder.html | 4 +- .../sync/db/mysql/class-use/DBSyncAgent.html | 4 +- .../db/mysql/class-use/DBSynchronizer.html | 4 +- .../class-use/InvalidDBMapFileException.html | 148 +++++++++++ javadoc/sync/db/mysql/class-use/SyncType.html | 4 +- javadoc/sync/db/mysql/class-use/TableMap.html | 4 +- javadoc/sync/db/mysql/package-frame.html | 8 +- javadoc/sync/db/mysql/package-summary.html | 23 +- javadoc/sync/db/mysql/package-tree.html | 13 +- javadoc/sync/db/mysql/package-use.html | 9 +- 42 files changed, 1132 insertions(+), 220 deletions(-) create mode 100644 javadoc/index-files/index-11.html create mode 100644 javadoc/index-files/index-12.html create mode 100644 javadoc/serialized-form.html create mode 100644 javadoc/sync/db/mysql/InvalidDBMapFileException.html create mode 100644 javadoc/sync/db/mysql/class-use/InvalidDBMapFileException.html diff --git a/javadoc/allclasses-frame.html b/javadoc/allclasses-frame.html index af1c16c..504cd35 100644 --- a/javadoc/allclasses-frame.html +++ b/javadoc/allclasses-frame.html @@ -2,10 +2,10 @@ - + All Classes - + @@ -18,6 +18,7 @@

All Classes

  • DBSyncAgent
  • DBSyncAgent.Builder
  • DBSynchronizer
    • +
  • InvalidDBMapFileException
  • SyncType
  • TableMap
    • diff --git a/javadoc/allclasses-noframe.html b/javadoc/allclasses-noframe.html index 1dc75f7..b52f0bb 100644 --- a/javadoc/allclasses-noframe.html +++ b/javadoc/allclasses-noframe.html @@ -2,10 +2,10 @@ - + All Classes - + @@ -18,6 +18,7 @@

    All Classes

  • DBSyncAgent
  • DBSyncAgent.Builder
  • DBSynchronizer
    • +
  • InvalidDBMapFileException
  • SyncType
  • TableMap
    • diff --git a/javadoc/constant-values.html b/javadoc/constant-values.html index a9ba1f8..73af5fa 100644 --- a/javadoc/constant-values.html +++ b/javadoc/constant-values.html @@ -2,10 +2,10 @@ - + Constant Field Values - + diff --git a/javadoc/deprecated-list.html b/javadoc/deprecated-list.html index f76dada..40715e2 100644 --- a/javadoc/deprecated-list.html +++ b/javadoc/deprecated-list.html @@ -2,10 +2,10 @@ - + Deprecated List - + diff --git a/javadoc/help-doc.html b/javadoc/help-doc.html index ad526f3..af74a97 100644 --- a/javadoc/help-doc.html +++ b/javadoc/help-doc.html @@ -2,10 +2,10 @@ - + API Help - + diff --git a/javadoc/index-files/index-1.html b/javadoc/index-files/index-1.html index 4d8d5a5..fbe724c 100644 --- a/javadoc/index-files/index-1.html +++ b/javadoc/index-files/index-1.html @@ -2,10 +2,10 @@ - + A-Index - + @@ -62,7 +62,7 @@ -
    A B C D G L R S T V  +
    A B C D G H I L R S T V 

    A

    @@ -91,7 +91,7 @@

    A

    Enum class that defines the type of attribute being mapped between two tables.
    -A B C D G L R S T V 
    +A B C D G H I L R S T V 
    diff --git a/javadoc/index-files/index-10.html b/javadoc/index-files/index-10.html index a6c3976..4a1e8df 100644 --- a/javadoc/index-files/index-10.html +++ b/javadoc/index-files/index-10.html @@ -2,16 +2,16 @@ - + -V-Index - +S-Index + @@ -37,7 +37,7 @@
    -
    A B C D G L R S T V  +
    A B C D G H I L R S T V  -

    V

    +

    S

    -
    valueOf(String) - Static method in enum sync.db.mysql.AttributeType
    +
    setClientDatabaseAddress(String) - Method in class sync.db.mysql.DBSyncAgent.Builder
    -
    Returns the enum constant of this type with the specified name.
    +
    Set the address of the client database.
    -
    valueOf(String) - Static method in enum sync.db.mysql.SyncType
    +
    setClientDatabaseConnectionOptions(String) - Method in class sync.db.mysql.DBSyncAgent.Builder
    -
    Returns the enum constant of this type with the specified name.
    +
    Set the optional connection string to be used for the client + connection.
    -
    values() - Static method in enum sync.db.mysql.AttributeType
    +
    setClientDatabaseName(String) - Method in class sync.db.mysql.DBSyncAgent.Builder
    -
    Returns an array containing the constants of this enum type, in -the order they are declared.
    +
    Set the name of the client database.
    -
    values() - Static method in enum sync.db.mysql.SyncType
    +
    setClientDatabasePassword(String) - Method in class sync.db.mysql.DBSyncAgent.Builder
    -
    Returns an array containing the constants of this enum type, in -the order they are declared.
    +
    Set the password to access the client database.
    +
    +
    setClientDatabasePort(int) - Method in class sync.db.mysql.DBSyncAgent.Builder
    +
    +
    Set the port for the client connection.
    +
    +
    setClientDatabaseUsername(String) - Method in class sync.db.mysql.DBSyncAgent.Builder
    +
    +
    Set the username to access the client database.
    +
    +
    setDBMap(DBMap) - Method in class sync.db.mysql.DBSyncAgent.Builder
    +
    +
    Set the database map.
    +
    +
    setServerDatabaseAddress(String) - Method in class sync.db.mysql.DBSyncAgent.Builder
    +
    +
    Set the address of the server database.
    +
    +
    setServerDatabaseConnectionOptions(String) - Method in class sync.db.mysql.DBSyncAgent.Builder
    +
    +
    Set the optional connection string to be used for the server + connection.
    +
    +
    setServerDatabaseName(String) - Method in class sync.db.mysql.DBSyncAgent.Builder
    +
    +
    Set the name of the server database.
    +
    +
    setServerDatabasePassword(String) - Method in class sync.db.mysql.DBSyncAgent.Builder
    +
    +
    Set the password to access the server database.
    +
    +
    setServerDatabasePort(int) - Method in class sync.db.mysql.DBSyncAgent.Builder
    +
    +
    Set the port for the server connection.
    +
    +
    setServerDatabaseUsername(String) - Method in class sync.db.mysql.DBSyncAgent.Builder
    +
    +
    Set the username to access the server database.
    +
    +
    setSyncInterval(int) - Method in class sync.db.mysql.DBSyncAgent.Builder
    +
    +
    Set the synchronization interval.
    +
    +
    setSyncInterval(int) - Method in class sync.db.mysql.DBSyncAgent
    +
    +
    Set the synchronization interval.
    +
    +
    stopSync() - Method in class sync.db.mysql.DBSyncAgent
    +
    +
    Stops the synchronization process.
    +
    +
    stopSync() - Method in class sync.db.mysql.DBSynchronizer
    +
     
    +
    sync() - Method in class sync.db.mysql.DBSyncAgent
    +
    +
    Performs initial synchronization between the client and the server + databases.
    +
    +
    sync.db.mysql - package sync.db.mysql
    +
     
    +
    SyncType - Enum in sync.db.mysql
    +
    +
    Enum class that defines the types of Synchronization available.
    -A B C D G L R S T V 
    +A B C D G H I L R S T V 
    @@ -106,7 +167,7 @@

    V

    • Frames
      • diff --git a/javadoc/index-files/index-11.html b/javadoc/index-files/index-11.html new file mode 100644 index 0000000..bbbbbfc --- /dev/null +++ b/javadoc/index-files/index-11.html @@ -0,0 +1,125 @@ + + + + + + +T-Index + + + + + + + +
      + + + + + +
      +
      + + + +
      + +
      + + +
      + +
      A B C D G H I L R S T V  + + +

      T

      +
      +
      TableMap - Class in sync.db.mysql
      +
      +
      An object of the class maps the source table to the destination table.
      +
      +
      TableMap(String, String, String, String) - Constructor for class sync.db.mysql.TableMap
      +
      +
      Create a new table map using this constructor.
      +
      +
      +A B C D G H I L R S T V 
      + +
      + + + + + +
      +
      + + + +
      + +
      + + +
      + + + diff --git a/javadoc/index-files/index-12.html b/javadoc/index-files/index-12.html new file mode 100644 index 0000000..1489264 --- /dev/null +++ b/javadoc/index-files/index-12.html @@ -0,0 +1,135 @@ + + + + + + +V-Index + + + + + + + +
      + + + + + +
      +
      + + + +
      + +
      + + +
      + +
      A B C D G H I L R S T V  + + +

      V

      +
      +
      valueOf(String) - Static method in enum sync.db.mysql.AttributeType
      +
      +
      Returns the enum constant of this type with the specified name.
      +
      +
      valueOf(String) - Static method in enum sync.db.mysql.SyncType
      +
      +
      Returns the enum constant of this type with the specified name.
      +
      +
      values() - Static method in enum sync.db.mysql.AttributeType
      +
      +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
      values() - Static method in enum sync.db.mysql.SyncType
      +
      +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
      +A B C D G H I L R S T V 
      + +
      + + + + + +
      +
      + + + +
      + +
      + + +
      + + + diff --git a/javadoc/index-files/index-2.html b/javadoc/index-files/index-2.html index 110343f..7a37cb4 100644 --- a/javadoc/index-files/index-2.html +++ b/javadoc/index-files/index-2.html @@ -2,10 +2,10 @@ - + B-Index - + @@ -62,7 +62,7 @@
    -
    A B C D G L R S T V  +
    A B C D G H I L R S T V 

    B

    @@ -73,7 +73,7 @@

    B

    properties have been set using the Builder class.
    -A B C D G L R S T V 
    +A B C D G H I L R S T V 
    diff --git a/javadoc/index-files/index-3.html b/javadoc/index-files/index-3.html index d68e15a..900c06e 100644 --- a/javadoc/index-files/index-3.html +++ b/javadoc/index-files/index-3.html @@ -2,10 +2,10 @@ - + C-Index - + @@ -62,7 +62,7 @@
    -
    A B C D G L R S T V  +
    A B C D G H I L R S T V 

    C

    @@ -72,7 +72,7 @@

    C

    Connects to the client and server databases as per the set properties.
    -A B C D G L R S T V 
    +A B C D G H I L R S T V 
    diff --git a/javadoc/index-files/index-4.html b/javadoc/index-files/index-4.html index 3ed6cc4..724d715 100644 --- a/javadoc/index-files/index-4.html +++ b/javadoc/index-files/index-4.html @@ -2,10 +2,10 @@ - + D-Index - + @@ -62,7 +62,7 @@
    -
    A B C D G L R S T V  +
    A B C D G H I L R S T V 

    D

    @@ -86,7 +86,9 @@

    D

    DBSyncAgent.Builder() - Constructor for class sync.db.mysql.DBSyncAgent.Builder
     
    DBSynchronizer - Class in sync.db.mysql
    -
     
    +
    +
    The private thread that does the actual work.
    +
    DBSynchronizer(Statement, Statement, DBMap) - Constructor for class sync.db.mysql.DBSynchronizer
     
    DBSynchronizer(Statement, Statement, DBMap, int) - Constructor for class sync.db.mysql.DBSynchronizer
    @@ -96,7 +98,7 @@

    D

    Disconnects the existing client and server connections safely.
    -A B C D G L R S T V 
    +A B C D G H I L R S T V 
    diff --git a/javadoc/index-files/index-5.html b/javadoc/index-files/index-5.html index e492981..4f5c2ee 100644 --- a/javadoc/index-files/index-5.html +++ b/javadoc/index-files/index-5.html @@ -2,10 +2,10 @@ - + G-Index - + @@ -62,7 +62,7 @@
    -
    A B C D G L R S T V  +
    A B C D G H I L R S T V 

    G

    @@ -72,6 +72,15 @@

    G

    Gets the entire attribute mapping between the source and the destination tables.
    +
    getDBMapFromFile(String) - Static method in class sync.db.mysql.DBMap
    +
    +
    Creates a database map from a valid dmml file using the dmml file's path.
    +
    +
    getDBMapFromFile(File) - Static method in class sync.db.mysql.DBMap
    +
    +
    Creates a database map from a valid dmml file using a File object containing + the dmml file.
    +
    getDestinationAttribute() - Method in class sync.db.mysql.AttributeMap
    Gets the attribute name of the destination table in the current attribute @@ -111,7 +120,7 @@

    G

    Gets the attribute type of the current attribute mapping.
    -A B C D G L R S T V 
    +A B C D G H I L R S T V 
    diff --git a/javadoc/index-files/index-6.html b/javadoc/index-files/index-6.html index 5523298..b3dfd70 100644 --- a/javadoc/index-files/index-6.html +++ b/javadoc/index-files/index-6.html @@ -2,16 +2,16 @@ - + -L-Index - +H-Index + @@ -62,17 +62,17 @@
    -
    A B C D G L R S T V  +
    A B C D G H I L R S T V  -

    L

    +

    H

    -
    liveSync() - Method in class sync.db.mysql.DBSyncAgent
    +
    hold() - Method in class sync.db.mysql.DBSyncAgent
    -
    Synchronizes the client and the server databases periodically.
    +
    Waits for the worker thread to finish its job before proceeding forward.
    -A B C D G L R S T V 
    +A B C D G H I L R S T V 
    diff --git a/javadoc/index-files/index-7.html b/javadoc/index-files/index-7.html index 32e838b..d7926ec 100644 --- a/javadoc/index-files/index-7.html +++ b/javadoc/index-files/index-7.html @@ -2,16 +2,16 @@ - + -R-Index - +I-Index + @@ -62,15 +62,17 @@
    -
    A B C D G L R S T V  +
    A B C D G H I L R S T V  -

    R

    +

    I

    -
    run() - Method in class sync.db.mysql.DBSynchronizer
    +
    InvalidDBMapFileException - Exception in sync.db.mysql
    +
     
    +
    InvalidDBMapFileException() - Constructor for exception sync.db.mysql.InvalidDBMapFileException
     
    -A B C D G L R S T V 
    +A B C D G H I L R S T V 
    diff --git a/javadoc/index-files/index-8.html b/javadoc/index-files/index-8.html index 6770d15..a0776cc 100644 --- a/javadoc/index-files/index-8.html +++ b/javadoc/index-files/index-8.html @@ -2,16 +2,16 @@ - + -S-Index - +L-Index + @@ -62,92 +62,17 @@
    -
    A B C D G L R S T V  +
    A B C D G H I L R S T V  -

    S

    +

    L

    -
    setClientDatabaseAddress(String) - Method in class sync.db.mysql.DBSyncAgent.Builder
    +
    liveSync() - Method in class sync.db.mysql.DBSyncAgent
    -
    Set the address of the client database.
    -
    -
    setClientDatabaseConnectionOptions(String) - Method in class sync.db.mysql.DBSyncAgent.Builder
    -
    -
    Set the optional connection string to be used for the client - connection.
    -
    -
    setClientDatabaseName(String) - Method in class sync.db.mysql.DBSyncAgent.Builder
    -
    -
    Set the name of the client database.
    -
    -
    setClientDatabasePassword(String) - Method in class sync.db.mysql.DBSyncAgent.Builder
    -
    -
    Set the password to access the client database.
    -
    -
    setClientDatabasePort(int) - Method in class sync.db.mysql.DBSyncAgent.Builder
    -
    -
    Set the port for the client connection.
    -
    -
    setClientDatabaseUsername(String) - Method in class sync.db.mysql.DBSyncAgent.Builder
    -
    -
    Set the username to access the client database.
    -
    -
    setDBMap(DBMap) - Method in class sync.db.mysql.DBSyncAgent.Builder
    -
    -
    Set the database map.
    -
    -
    setServerDatabaseAddress(String) - Method in class sync.db.mysql.DBSyncAgent.Builder
    -
    -
    Set the address of the server database.
    -
    -
    setServerDatabaseConnectionOptions(String) - Method in class sync.db.mysql.DBSyncAgent.Builder
    -
    -
    Set the optional connection string to be used for the server - connection.
    -
    -
    setServerDatabaseName(String) - Method in class sync.db.mysql.DBSyncAgent.Builder
    -
    -
    Set the name of the server database.
    -
    -
    setServerDatabasePassword(String) - Method in class sync.db.mysql.DBSyncAgent.Builder
    -
    -
    Set the password to access the server database.
    -
    -
    setServerDatabasePort(int) - Method in class sync.db.mysql.DBSyncAgent.Builder
    -
    -
    Set the port for the server connection.
    -
    -
    setServerDatabaseUsername(String) - Method in class sync.db.mysql.DBSyncAgent.Builder
    -
    -
    Set the username to access the server database.
    -
    -
    setSyncInterval(int) - Method in class sync.db.mysql.DBSyncAgent.Builder
    -
    -
    Set the synchronization interval.
    -
    -
    setSyncInterval(int) - Method in class sync.db.mysql.DBSyncAgent
    -
    -
    Set the synchronization interval.
    -
    -
    stopSync() - Method in class sync.db.mysql.DBSyncAgent
    -
    -
    Stops the synchronization process.
    -
    -
    stopSync() - Method in class sync.db.mysql.DBSynchronizer
    -
     
    -
    sync() - Method in class sync.db.mysql.DBSyncAgent
    -
    -
    Performs initial synchronization between the client and the server - databases.
    -
    -
    sync.db.mysql - package sync.db.mysql
    -
     
    -
    SyncType - Enum in sync.db.mysql
    -
    -
    Enum class that defines the types of Synchronization available.
    +
    Synchronizes the client and the server databases periodically.
    -A B C D G L R S T V 
    +A B C D G H I L R S T V 
    diff --git a/javadoc/index-files/index-9.html b/javadoc/index-files/index-9.html index a3c239b..5c5e647 100644 --- a/javadoc/index-files/index-9.html +++ b/javadoc/index-files/index-9.html @@ -2,16 +2,16 @@ - + -T-Index - +R-Index + @@ -62,21 +62,15 @@
    -
    A B C D G L R S T V  +
    A B C D G H I L R S T V  -

    T

    +

    R

    -
    TableMap - Class in sync.db.mysql
    -
    -
    An object of the class maps the source table to the destination table.
    -
    -
    TableMap(String, String, String, String) - Constructor for class sync.db.mysql.TableMap
    -
    -
    Create a new table map using this constructor.
    -
    +
    run() - Method in class sync.db.mysql.DBSynchronizer
    +
     
    -A B C D G L R S T V 
    +A B C D G H I L R S T V 
    diff --git a/javadoc/index.html b/javadoc/index.html index 7442c4c..3647006 100644 --- a/javadoc/index.html +++ b/javadoc/index.html @@ -2,7 +2,7 @@ - + Generated Documentation (Untitled) + + +
    + + + + + +
    +
    +
      +
    • Prev
      • +
    • Next
      • +
    + + +
    + +
    + + +
    + +
    +

    Serialized Form

    +
    +
    + +
    + +
    + + + + + +
    +
    +
      +
    • Prev
      • +
    • Next
      • +
    + + +
    + +
    + + +
    + + + diff --git a/javadoc/sync/db/mysql/AttributeMap.html b/javadoc/sync/db/mysql/AttributeMap.html index 9de7bad..147eb56 100644 --- a/javadoc/sync/db/mysql/AttributeMap.html +++ b/javadoc/sync/db/mysql/AttributeMap.html @@ -2,10 +2,10 @@ - + AttributeMap - + diff --git a/javadoc/sync/db/mysql/AttributeType.html b/javadoc/sync/db/mysql/AttributeType.html index c22e738..1baf461 100644 --- a/javadoc/sync/db/mysql/AttributeType.html +++ b/javadoc/sync/db/mysql/AttributeType.html @@ -2,10 +2,10 @@ - + AttributeType - + diff --git a/javadoc/sync/db/mysql/DBMap.html b/javadoc/sync/db/mysql/DBMap.html index b6a71a0..701dd04 100644 --- a/javadoc/sync/db/mysql/DBMap.html +++ b/javadoc/sync/db/mysql/DBMap.html @@ -2,10 +2,10 @@ - + DBMap - + @@ -144,6 +144,19 @@

    Method Summary

    +static DBMap +getDBMapFromFile(java.io.File file) +
    Creates a database map from a valid dmml file using a File object containing + the dmml file.
    + + + +static DBMap +getDBMapFromFile(java.lang.String filepath) +
    Creates a database map from a valid dmml file using the dmml file's path.
    + + + java.util.ArrayList<TableMap> getTableMap()
    Gets a set of all table mapping between the source and the destination @@ -214,7 +227,7 @@

    addTableMap

    -
      +

      • getTableMap

        public java.util.ArrayList<TableMap> getTableMap()
        @@ -225,6 +238,43 @@

        getTableMap

        databases
      + + + +
        +
      • +

        getDBMapFromFile

        +
        public static DBMap getDBMapFromFile(java.lang.String filepath)
+                              throws java.io.FileNotFoundException,
+                                     InvalidDBMapFileException
        +
        Creates a database map from a valid dmml file using the dmml file's path. + Converts the file path to a file object and internally calls the + getDBMapFromFile(File) method.
        +
        Parameters:
        filepath - full path of the dmml file as a string
        +
        Returns:
        database map
        +
        Throws:
        +
        java.io.FileNotFoundException - if file is not found
        +
        InvalidDBMapFileException - if the dmml file is invalid
        +
        • +
      + + + +
        +
      • +

        getDBMapFromFile

        +
        public static DBMap getDBMapFromFile(java.io.File file)
+                              throws java.io.FileNotFoundException,
+                                     InvalidDBMapFileException
        +
        Creates a database map from a valid dmml file using a File object containing + the dmml file.
        +
        Parameters:
        file - a file object containing the dmml file
        +
        Returns:
        database map
        +
        Throws:
        +
        java.io.FileNotFoundException - if file not found
        +
        InvalidDBMapFileException - if the dmml file is invalid
        +
        • +
    diff --git a/javadoc/sync/db/mysql/DBSyncAgent.Builder.html b/javadoc/sync/db/mysql/DBSyncAgent.Builder.html index db6a826..4825e3f 100644 --- a/javadoc/sync/db/mysql/DBSyncAgent.Builder.html +++ b/javadoc/sync/db/mysql/DBSyncAgent.Builder.html @@ -2,10 +2,10 @@ - + DBSyncAgent.Builder - + diff --git a/javadoc/sync/db/mysql/DBSyncAgent.html b/javadoc/sync/db/mysql/DBSyncAgent.html index 5a090ae..8870641 100644 --- a/javadoc/sync/db/mysql/DBSyncAgent.html +++ b/javadoc/sync/db/mysql/DBSyncAgent.html @@ -2,10 +2,10 @@ - + DBSyncAgent - + @@ -180,23 +180,29 @@

    Method Summary

    void +hold() +
    Waits for the worker thread to finish its job before proceeding forward.
    + + + +void liveSync()
    Synchronizes the client and the server databases periodically.
    - + void setSyncInterval(int syncInterval)
    Set the synchronization interval.
    - + void stopSync()
    Stops the synchronization process.
    - + void sync()
    Performs initial synchronization between the client and the server @@ -288,7 +294,7 @@

    stopSync

    -
      +

      • disconnect

        public void disconnect()
        @@ -296,6 +302,17 @@

        disconnect

        Call this method after calling stopSync().
    + + + +
      +
    • +

      hold

      +
      public void hold()
      +
      Waits for the worker thread to finish its job before proceeding forward. + Call this method between sync() and liveSync().
      +
      • +
    diff --git a/javadoc/sync/db/mysql/DBSynchronizer.html b/javadoc/sync/db/mysql/DBSynchronizer.html index e8daaba..bc84e01 100644 --- a/javadoc/sync/db/mysql/DBSynchronizer.html +++ b/javadoc/sync/db/mysql/DBSynchronizer.html @@ -2,10 +2,10 @@ - + DBSynchronizer - + @@ -37,7 +37,7 @@
    • Frames
      • @@ -103,6 +103,8 @@

      Class DBSynchronizer

      public class DBSynchronizer
 extends java.lang.Object
 implements java.lang.Runnable
      +
      The private thread that does the actual work. + Only accessible from within DBSyncAgent.
    @@ -255,7 +257,7 @@

    stopSync

    • Frames
      • diff --git a/javadoc/sync/db/mysql/InvalidDBMapFileException.html b/javadoc/sync/db/mysql/InvalidDBMapFileException.html new file mode 100644 index 0000000..8eafd12 --- /dev/null +++ b/javadoc/sync/db/mysql/InvalidDBMapFileException.html @@ -0,0 +1,249 @@ + + + + + + +InvalidDBMapFileException + + + + + + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      +
        +
      • Detail: 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      +
      + + +
      + + +
      +
      sync.db.mysql
      +

      Class InvalidDBMapFileException

      +
      +
      +
        +
      • java.lang.Object
        • +
      • +
          +
        • java.lang.Throwable
          • +
        • +
            +
          • java.lang.Exception
            • +
          • +
              +
            • sync.db.mysql.InvalidDBMapFileException
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      +
        +
      • +
        +
        All Implemented Interfaces:
        +
        java.io.Serializable
        +
        +
        +
        +
        public class InvalidDBMapFileException
+extends java.lang.Exception
        +
        See Also:
        Serialized Form
        +
        • +
      +
      +
      +
        +
      • + + + +
          +
        • + + +

          Method Summary

          +
            +
          • + + +

            Methods inherited from class java.lang.Throwable

            +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            • +
          +
            +
          • + + +

            Methods inherited from class java.lang.Object

            +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            • +
          +
          • +
        +
        • +
      +
      +
      +
        +
      • + +
          +
        • + + +

          Constructor Detail

          + + + +
            +
          • +

            InvalidDBMapFileException

            +
            public InvalidDBMapFileException()
            +
            • +
          +
          • +
        +
        • +
      +
      +
      + + +
      + + + + + +
      +
      + + + +
      + +
      +
      +
        +
      • Summary: 
        • +
      • Nested | 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      +
        +
      • Detail: 
        • +
      • Field | 
        • +
      • Constr | 
        • +
      • Method
        • +
      +
      + + +
      + + + diff --git a/javadoc/sync/db/mysql/SyncType.html b/javadoc/sync/db/mysql/SyncType.html index a826a9f..59c4fd3 100644 --- a/javadoc/sync/db/mysql/SyncType.html +++ b/javadoc/sync/db/mysql/SyncType.html @@ -2,10 +2,10 @@ - + SyncType - + @@ -36,7 +36,7 @@
      @@ -279,7 +279,7 @@

      valueOf

      diff --git a/javadoc/sync/db/mysql/TableMap.html b/javadoc/sync/db/mysql/TableMap.html index 3d885e8..9f54723 100644 --- a/javadoc/sync/db/mysql/TableMap.html +++ b/javadoc/sync/db/mysql/TableMap.html @@ -2,10 +2,10 @@ - + TableMap - + diff --git a/javadoc/sync/db/mysql/class-use/AttributeMap.html b/javadoc/sync/db/mysql/class-use/AttributeMap.html index 191c591..3a580ee 100644 --- a/javadoc/sync/db/mysql/class-use/AttributeMap.html +++ b/javadoc/sync/db/mysql/class-use/AttributeMap.html @@ -2,10 +2,10 @@ - + Uses of Class sync.db.mysql.AttributeMap - + diff --git a/javadoc/sync/db/mysql/class-use/AttributeType.html b/javadoc/sync/db/mysql/class-use/AttributeType.html index 082648f..acb13aa 100644 --- a/javadoc/sync/db/mysql/class-use/AttributeType.html +++ b/javadoc/sync/db/mysql/class-use/AttributeType.html @@ -2,10 +2,10 @@ - + Uses of Class sync.db.mysql.AttributeType - + diff --git a/javadoc/sync/db/mysql/class-use/DBMap.html b/javadoc/sync/db/mysql/class-use/DBMap.html index 14939ed..4ee1f93 100644 --- a/javadoc/sync/db/mysql/class-use/DBMap.html +++ b/javadoc/sync/db/mysql/class-use/DBMap.html @@ -2,10 +2,10 @@ - + Uses of Class sync.db.mysql.DBMap - + @@ -74,6 +74,28 @@

      Uses of Class
      syn

      Uses of DBMap in sync.db.mysql

      + + + + + + + + + + + + + + + +
      Methods in sync.db.mysql that return DBMap 
      Modifier and TypeMethod and Description
      static DBMapDBMap.getDBMapFromFile(java.io.File file) +
      Creates a database map from a valid dmml file using a File object containing + the dmml file.
      +
      static DBMapDBMap.getDBMapFromFile(java.lang.String filepath) +
      Creates a database map from a valid dmml file using the dmml file's path.
      +
      + diff --git a/javadoc/sync/db/mysql/class-use/DBSyncAgent.Builder.html b/javadoc/sync/db/mysql/class-use/DBSyncAgent.Builder.html index eb46b21..b6b4544 100644 --- a/javadoc/sync/db/mysql/class-use/DBSyncAgent.Builder.html +++ b/javadoc/sync/db/mysql/class-use/DBSyncAgent.Builder.html @@ -2,10 +2,10 @@ - +Uses of Class sync.db.mysql.DBSyncAgent.Builder - + diff --git a/javadoc/sync/db/mysql/class-use/DBSyncAgent.html b/javadoc/sync/db/mysql/class-use/DBSyncAgent.html index 197bf11..ad4500c 100644 --- a/javadoc/sync/db/mysql/class-use/DBSyncAgent.html +++ b/javadoc/sync/db/mysql/class-use/DBSyncAgent.html @@ -2,10 +2,10 @@ - +Uses of Class sync.db.mysql.DBSyncAgent - + diff --git a/javadoc/sync/db/mysql/class-use/DBSynchronizer.html b/javadoc/sync/db/mysql/class-use/DBSynchronizer.html index 9361a71..8409b11 100644 --- a/javadoc/sync/db/mysql/class-use/DBSynchronizer.html +++ b/javadoc/sync/db/mysql/class-use/DBSynchronizer.html @@ -2,10 +2,10 @@ - +Uses of Class sync.db.mysql.DBSynchronizer - + diff --git a/javadoc/sync/db/mysql/class-use/InvalidDBMapFileException.html b/javadoc/sync/db/mysql/class-use/InvalidDBMapFileException.html new file mode 100644 index 0000000..a4d7b4f --- /dev/null +++ b/javadoc/sync/db/mysql/class-use/InvalidDBMapFileException.html @@ -0,0 +1,148 @@ + + + + + + +Uses of Class sync.db.mysql.InvalidDBMapFileException + + + + + + + +
      + + + + + +
      +
      +
        +
      • Prev
        • +
      • Next
        • +
      + + +
      + +
      + + +
      + +
      +

      Uses of Class
      sync.db.mysql.InvalidDBMapFileException

      +
      +
      +
      Methods in sync.db.mysql with parameters of type DBMap 
      Modifier and Type
      + + + + + + + + + + + + + + + +
      Methods in sync.db.mysql that throw InvalidDBMapFileException 
      Modifier and TypeMethod and Description
      static DBMapDBMap.getDBMapFromFile(java.io.File file) +
      Creates a database map from a valid dmml file using a File object containing + the dmml file.
      +
      static DBMapDBMap.getDBMapFromFile(java.lang.String filepath) +
      Creates a database map from a valid dmml file using the dmml file's path.
      +
      + +
    + + +
    + +
    + + + + + +
    +
    +
      +
    • Prev
      • +
    • Next
      • +
    + + +
    + +
    + + +
    + + + diff --git a/javadoc/sync/db/mysql/class-use/SyncType.html b/javadoc/sync/db/mysql/class-use/SyncType.html index 5fe62ad..e74cc0a 100644 --- a/javadoc/sync/db/mysql/class-use/SyncType.html +++ b/javadoc/sync/db/mysql/class-use/SyncType.html @@ -2,10 +2,10 @@ - + Uses of Class sync.db.mysql.SyncType - + diff --git a/javadoc/sync/db/mysql/class-use/TableMap.html b/javadoc/sync/db/mysql/class-use/TableMap.html index a03a96c..c93492f 100644 --- a/javadoc/sync/db/mysql/class-use/TableMap.html +++ b/javadoc/sync/db/mysql/class-use/TableMap.html @@ -2,10 +2,10 @@ - + Uses of Class sync.db.mysql.TableMap - + diff --git a/javadoc/sync/db/mysql/package-frame.html b/javadoc/sync/db/mysql/package-frame.html index 0abfc6a..fe5a086 100644 --- a/javadoc/sync/db/mysql/package-frame.html +++ b/javadoc/sync/db/mysql/package-frame.html @@ -2,10 +2,10 @@ - + sync.db.mysql - + @@ -25,6 +25,10 @@

    Enums

  • AttributeType
  • SyncType
    • +

    Exceptions

    +
    diff --git a/javadoc/sync/db/mysql/package-summary.html b/javadoc/sync/db/mysql/package-summary.html index 07a84fb..ba758b6 100644 --- a/javadoc/sync/db/mysql/package-summary.html +++ b/javadoc/sync/db/mysql/package-summary.html @@ -2,10 +2,10 @@ - + sync.db.mysql - + @@ -102,7 +102,9 @@

    Package sync.db.mysql

    DBSynchronizer -  + +
    The private thread that does the actual work.
    + TableMap @@ -136,6 +138,21 @@

    Package sync.db.mysql

    +
  • + + + + + + + + + + + + +
    Exception Summary 
    ExceptionDescription
    InvalidDBMapFileException 
    +
    • diff --git a/javadoc/sync/db/mysql/package-tree.html b/javadoc/sync/db/mysql/package-tree.html index 09b0f8e..045c422 100644 --- a/javadoc/sync/db/mysql/package-tree.html +++ b/javadoc/sync/db/mysql/package-tree.html @@ -2,10 +2,10 @@ - + sync.db.mysql Class Hierarchy - + @@ -76,6 +76,15 @@

    Class Hierarchy

  • sync.db.mysql.DBSyncAgent.Builder
  • sync.db.mysql.DBSynchronizer (implements java.lang.Runnable)
  • sync.db.mysql.TableMap
    • +
  • java.lang.Throwable (implements java.io.Serializable) + +
    • diff --git a/javadoc/sync/db/mysql/package-use.html b/javadoc/sync/db/mysql/package-use.html index cee58fc..d28b4f7 100644 --- a/javadoc/sync/db/mysql/package-use.html +++ b/javadoc/sync/db/mysql/package-use.html @@ -2,10 +2,10 @@ - + Uses of Package sync.db.mysql - + @@ -103,11 +103,14 @@

    Uses of Package
    sync. +InvalidDBMapFileException  + + SyncType
    Enum class that defines the types of Synchronization available.
    - + TableMap
    An object of the class maps the source table to the destination table.