From eada699293bd10cc3b544bf15ebef6be06bce6eb Mon Sep 17 00:00:00 2001 From: Ludovic Pouzenc Date: Sun, 30 Nov 2014 17:32:42 +0100 Subject: Adding class diagram about data handling. Removing ugly auto-generated inheritance diagram. --- doc/diagrams/data.plant | 35 +++++++++++++++++++++++++++++++++++ doc/diagrams/data.svg | 1 + doc/diagrams/inheritance.plant | 28 ---------------------------- doc/diagrams/inheritance.svg | 1 - 4 files changed, 36 insertions(+), 29 deletions(-) create mode 100644 doc/diagrams/data.plant create mode 100644 doc/diagrams/data.svg delete mode 100644 doc/diagrams/inheritance.plant delete mode 100644 doc/diagrams/inheritance.svg diff --git a/doc/diagrams/data.plant b/doc/diagrams/data.plant new file mode 100644 index 0000000..7e98f4e --- /dev/null +++ b/doc/diagrams/data.plant @@ -0,0 +1,35 @@ +@startuml +abstract class AbstractMVDataReader { + #String dataSourceName + +void remove() + +String getDataSourceName() +} + +interface MVDataReader { + String getDataSourceName() +} + +interface "Iterator" as Iterator_MVDataEntry_ { +} + + +interface "Iterable" as Iterable_MVDataEntry_ { +} + +class MVDataEntry { + -String key + -HashMultimap attrValPairs + +MVDataEntry(String key) + +Set getValues(String attr) + +Set getChangedAttributes(MVDataEntry original) + +void mergeValues(boolean appendMode, MVDataEntry[] entries) +} +interface "Comparable" as Comparable_MVDataEntry_ { +} + +Comparable_MVDataEntry_ <|.. MVDataEntry +Iterable_MVDataEntry_ <|.. MVDataReader +Iterable_MVDataEntry_ .up.> MVDataEntry +Iterator_MVDataEntry_ <|.. MVDataReader +MVDataReader <|.. AbstractMVDataReader +@enduml \ No newline at end of file diff --git a/doc/diagrams/data.svg b/doc/diagrams/data.svg new file mode 100644 index 0000000..58bba56 --- /dev/null +++ b/doc/diagrams/data.svg @@ -0,0 +1 @@ +AbstractMVDataReaderString dataSourceNamevoid remove()String getDataSourceName()MVDataReaderString getDataSourceName()Iterator<MVDataEntry>Iterable<MVDataEntry>MVDataEntryString keyHashMultimap<String,String> attrValPairsMVDataEntry(String key)Set<String> getValues(String attr)Set<String> getChangedAttributes(MVDataEntry original)void mergeValues(boolean appendMode, MVDataEntry[] entries)Comparable<MVDataEntry> \ No newline at end of file diff --git a/doc/diagrams/inheritance.plant b/doc/diagrams/inheritance.plant deleted file mode 100644 index 5b763e6..0000000 --- a/doc/diagrams/inheritance.plant +++ /dev/null @@ -1,28 +0,0 @@ -@startuml -abstract class data.io.AbstractMVDataReader -abstract class sync.AbstractSyncTask -interface data.io.MVDataReader -interface data.io.MVDataWriter -interface java.io.Closeable -interface java.lang.Comparable -interface java.lang.Iterable -interface java.util.Iterator -interface java.util.concurrent.Callable -data.io.AbstractMVDataReader --|> data.io.MVDataReader -sync.AbstractSyncTask --|> java.util.concurrent.Callable -data.MVDataEntry --|> java.lang.Comparable -data.filters.MVDataCombiner --|> data.io.AbstractMVDataReader -data.io.ConnectionsHolder --|> java.io.Closeable -data.io.SafeDataReader --|> data.io.AbstractMVDataReader -data.io.csv.CSVDataReader --|> data.io.AbstractMVDataReader -data.io.ldap.LDAPConnectionWrapper --|> java.io.Closeable -data.io.ldap.LDAPFlatDataReader --|> data.io.AbstractMVDataReader -data.io.ldap.LDAPFlatDataWriter --|> data.io.MVDataWriter -data.io.sql.SQLConnectionWrapper --|> java.io.Closeable -data.io.sql.SQLRelDataReader --|> data.io.AbstractMVDataReader -data.io.stub.StubDataReader --|> data.io.AbstractMVDataReader -data.io.stub.StubDataWriter --|> data.io.MVDataWriter -sync.BasicSyncTask --|> sync.AbstractSyncTask -data.io.MVDataReader --|> java.lang.Iterable -data.io.MVDataReader --|> java.util.Iterator -@enduml diff --git a/doc/diagrams/inheritance.svg b/doc/diagrams/inheritance.svg deleted file mode 100644 index 4004ae8..0000000 --- a/doc/diagrams/inheritance.svg +++ /dev/null @@ -1 +0,0 @@ -data.iosyncjava.iojava.langjava.utiljava.util.concurrentdatadata.filtersdata.io.csvdata.io.ldapdata.io.sqldata.io.stubAbstractMVDataReaderMVDataReaderMVDataWriterConnectionsHolderSafeDataReaderAbstractSyncTaskBasicSyncTaskCloseableComparableIterableIteratorCallableMVDataEntryMVDataCombinerCSVDataReaderLDAPConnectionWrapperLDAPFlatDataReaderLDAPFlatDataWriterSQLConnectionWrapperSQLRelDataReaderStubDataReaderStubDataWriter \ No newline at end of file -- cgit v1.2.3