Analysis and Design Document

NFD<v0.
1> 1
Compare folder system
ANALYSIS and DESIGN DOCUMENT

<Compare two folder system>
Sinh viên:
 Lê Văn Quý Hoàng
 Trần Đình Hoàng Huy
 Kiều Cao Khanh
 Nguyễn Vẵn Quyền
 Nguyễn Thị Hồng Nhung
NFD<v0.1> 2
Use-case diagram
Picture 1 Use case diagram
Following descriptions are the detail explanation of the cases on the diagram.
*Note: N/A is the shortcut of Not Available.
NFD001- Configure compare criterion
Use Case ID: NFD001

Use Case Name: Configure compare criterion
Created By: KhanhKC Last Updated By: KhanhKC
Date Created: 10/3/2015 Date Last Updated: 26/03/2015
Actor: Client
Description: Client modifies criterion which will be used in compare
process.
Preconditions: Client on main screen
Post - conditions: The setting of client has to be saved and it is applied
immediately in the next compare process
Priority: Normal
Frequency of Use: Sometime
Normal Course of Events: 1. Client requests to change criterion.
2. System enables change criterion slider.
3. Client uses slider to change value of criterion.
4. Client requests to save setting.
5. System saves setting.
6. System disables change criterion slider.
Alternative Courses: N/A
Exceptions: N/A
Includes: N/A
Specical Requirements: N/A
Assumptions: N/A
Notes and Issues: N/A
NFD<v0.1> 3
Picture 2 Configure compare criterion
NFD002 - Choose folder
Use Case ID: NFD002

Use Case Name: Choose folder
Created By: NhungNTH Last Updated By: NhungNTH
Actor: Client
Description: Client chooses two folder which system need to compare.
Preconditions: Client is working on the main screen.
Post - conditions: Main screen shows absolutely path of folders.
Priority: High
Frequency of Use: Always
Normal Course of Events: 1. Client clicks “Open Folder 1” button
2. System requests client to input folder 1 path.
3. Client inputs folder 1 path.
4. System displays folder 1 path.
5. Client clicks “Open Folder 2” button
8. System display folder 2 path.
Alternative Courses: 1. Client clicks “Open Folder 1” button

4. System displays folder 1 path.
5. Client clicks “Open Folder 2” button
8. System displays error message "Please select 2 difference
folders !".
NFD<v0.1> 4
Exceptions:
Includes: N/A
Assumptions: N/A
Notes and Issues: Client can choose folder only.
Picture 3 Choose folders

NFD<v0.1> 5
NFD003 - Compare two folder
Use Case ID: NFD003

Use Case Name: Compare two folder
Created By: HoangLVQ Last Updated By: HoangLVQ
Actor: Client
Description: Client requests system to compare all of the files in two
folders and in their sub-folders to determine which one is the
newer.
Preconditions: Client is working on main screen
Client inputs completely the path of two folders.
The setting of clients has to be saved before.
Post - conditions: The result of comparing is displayed
Priority: High
Normal Course of Events: 1. Client chooses two folders.
2. Client requests compare two folders.
3. System displays the status of process in the main screen.
4. System displays the comparing result when process
comparing finished (refer to NFD-005 – view compared
result).
Exceptions: - In case, client just only chooses one folder and then requests
to compare , system will show notification message “Please
enter 2 folder paths !”.
- In case, client requests to change criterion but doesn't finish
this action ( don't click "Save" button ) , system will show

notification message "Please save criterion setting first !"
Includes: View compared result.

Assumptions: N/A
Notes and Issues: Client should choose fully folders and complete the action of
changing criterion.
NFD<v0.1> 6
Picture 4 compare two folder
NFD004 - Cancel compare process
NFD004
Use Case ID:
Use Case Name: Cancel compare process
Created By: KhanhKC Last Updated By: KhanhKC
Actor: Client
Description: Client wants to cancel the compare process when it’s running.
Preconditions: Compare process is running
Post - conditions: The compare process is stop.
Priority: High
NFD<v0.1> 7

Normal Course of Events: 1. Client requests to cancel the compare process.
2. System display a confirm dialog.
3. Client confirms to cancel the compare process.
4. System cancels the compare process.
5. System backs to main screen.
Alternative Courses: 1. Client requests to cancel compare process.
2. System show a confirm dialog.
3. Client confirms to continue the compare process.
4. System backs to main screen.
Exceptions: N/A
Includes: N/A
Assumptions: N/A
Picture 5 Cancel compare process

NFD<v0.1> 8
NFD005 - View compared result
Use Case ID: NFD005

Use Case Name: View compared result
Actor: Client
Description: System displays the compared result on main screen.
Preconditions: After comparing progress step is completed.
Post - conditions: The compare result is displayed on the main screen.
Priority: High
Normal Course of Events: 1. System extracts the data in the memory and display it on
the screen
2. Client could request to view the detail result. (refer to
NFD-006 –View compared detail )
Exceptions: N/A
Includes: N/A
Assumptions: N/A
Picture 6 View compared result

NFD<v0.1> 9
NFD006 - View compared detail
Use Case ID: NFD006

Use Case Name: View compared detail
Actor: Client
Description: System returns the detail result when client clicks “View
Detail” button.
Preconditions: After the compared result is displayed.
Post - conditions: The detail result is displayed on the main screen.
Priority: Normal
Frequency of Use: Sometime
Normal Course of Events: 1. Client requests to view detail result.
2. System displays detail result screen
3. Client may use keyboard or mouse to scroll to see
compared detail.
Exceptions: N/A
Includes: N/A
Assumptions: N/A
Picture 7 View compared detail

NFD<v0.1> 10
Analysis Class Diagram
Picture 8 Analysis Class Diagram
Class Responsibility and Collaboration
MainScreen
Responsibilities Collaboration
+ displays control option for user interaction CompareProcess
+ handles detecting folders comparing DetailScreen
+ displays compare result
+ handles setting change criterion request
+ displays compare criterion configuration
settings
+ handles displaying compared detail
request
+ knows CompareProcess
+ knows DetailScreen
NFD<v0.1> 11
DetailScreen
+ displays compared detail result
RegisteredFolder
+ stores registered folder information
+ stores list files of each folder
CompareProcess
+ knows MainScreen MainScreen
+ knows RegisteredFolder RegisteredFolder
+ knows Result Result
+ knows CompareThread CompareThread
+ knows ScanFolderController ScanFolderController
+ knows CompareCOntroller CompareCOntroller
+ knows CriterionController CriterionController
+ knows DisplayController DisplayController
+ handle setting the configuration criterion
function.
+ handle choosing the folder function.
+ handle comparing process.
+ routes the request of client to extract
controller that handle request.
+ store all common data of process.
CompareThread
+ knows CompareProcess CompareProcess
+ knows ScanFolderController ScanFolderController
+ knows CompareController CompareController
+ knows CriterionController CriterionController
+ knows DisplayThread DisplayThread
+ handle comparing process on a separate
thread
DisplayThread
+ handle displaying result on a separate
thread
NFD<v0.1> 12
ScanFolderController
+ knows ScanFolderLib, which is an ScanFolderLib
attached component from outside
application
+ handle choosing folder function
+ handle scanning all files of each folder to
system.
+ determine size of smaller folder.
CompareController
+ knows CompareController CompareProcess
+ knows Compare_Lib, which is an Compare_Lib
attached component from outside
application
+ determine same name files / different
name files/newer files/ newest file.
CriterionController
+ knows Criterion1 (an example of an Criterion1
outside component)
+ register an outside component to system
+ handle checking all criterions
+ update data into CompareProcess
Criterion1
+ Process checking conditions according to
the separate rules.
Result
+ Stores compared result.
DisplayController
+ knows Result Result
+ handle getting and displaying data to
main screen.
NFD<v0.1> 13
Interactive Diagram
Configure compare criterion
Picture 9 Configure compare criterion
Choose folders
Picture 10 Choose folders

NFD<v0.1> 14
Compare two folders
Picture 11 Compare two folders
Cancel Compare Process
Picture 12 Cancel Compare Process

NFD<v0.1> 15
View compare result
Picture 13 View compare result
ViewDetailResult
Picture 14 View Detail Result

NFD<v0.1> 16
State-Machine diagram
Picture 15 State-Machine diagram
Class Specification
Picture 16 Class Specification

NFD<v0.1> 17
MainScreen
Attributes
Name Type Initialize Description
cpObject CompareProcess Reference to
CompareProcess
Controller
Methods
Method Name registerObjects Scope private
Return Return Type Description
N/A None Register all elements that
need in system.
Parameter Type DefaultValue
N/A None N/A
Method Name show Scope public
N/A None Displays control option for user
interaction
N/A None
Method Name btnOpenFolder1ActionPerformed Scope private
N/A None Handle choosing the first folder
evt java.awt.event.ActionEvent
Method Name btnOpenFolder2ActionPerformed Scope private
N/A None Handle choosing the second
folder
Method Name btnCompareActionPerformed Scope private
N/A None Handle comaring two folders
Method Name btnCancelActionPerformed Scope private
N/A None
Method Name checkTheSameFolders Scope private
N/A None Check if client chooses the
same folders to compare
numFolder int N/A
NFD<v0.1> 18
CompareProcess
Attributes
rFolder1 RegisteredFolder Reference to the
registered folder
rFolder2 RegisteredFolder Reference to the
registered folder
finalResult Result Reference to the
final result
cmpT CompareThread Reference to the
comparethread
lstObjGUI Object[] Store the list of object
lstKS HashMap<String,Controller> Reference to the map
of <String,Controller>
Methods
Method Name registerControllers Scope public
N/A None Allows register controllers into system.
Each controller executes an separate
task.
kSObject Controller N/A
Method Name chooseFolder1 Scope public
N/A boolean Handles select folders to input path
into system
N/A None N/A
Method Name chooseFolder2 Scope public
N/A boolean Handles select folders to input path
into system
N/A None N/A
Method Name compare Scope public
N/A None Starts the comparing process
N/A None N/A
Method Name cancelCompare Scope public
N/A None Stop the comparing process
N/A None N/A
Method Name emptyListFilesInFolder Scope public
N/A None Empty the list file in Folder
num int N/A
Method Name getMapFinalResult Scope public
N/A HashMap<String,List<File[]>> Gets the final list result
NFD<v0.1> 19
N/A None N/A

Method Name setMapFinalResult Scope public
N/A None Sets the final list result
lstNew HashMap<String,List<File[]>> N/A
Method Name getSizeMinFolder Scope public
N/A int Get the size of min folder
N/A None N/A
Method Name setSizeMinFolder Scope public
N/A None Updates the size into the folder
size int N/A
Method Name setConfig Scope public
N/A None Handles setting the number percent of
criterion
num int N/A
DetailScreen
Attributes
header String[] Store the header of
the Detail Screen
Methods
Method Name DetailScreen Scope public
N/A None
header String[] N/A
dataFiles HashMap<String,List<File[]>> N/A
RegisteredFolder
Attributes
folder File Reference to the file
lstFiles List<File> Store the list of files
Methods
Method Name setLstFiles Scope public
N/A None
lstFiles List<File> N/A
Method Name getLstFiles Scope public
lstFiles List<File>
NFD<v0.1> 20
N/A None N/A

Method Name getFolder Scope public
folder File
N/A None N/A
Method Name setFolder Scope public
N/A None
folder File N/A
Controller
Attributes
cpObject CompareProcess Reference to the
compare process
nameController String Reference to the
name of controller
Methods
Method Name getNameController Scope public
N/A String
N/A None N/A
ScanFolderController
Attributes
fComponent IFolderController Reference to the folder
controller
Methods
Method Name openFolder Scope public
N/A boolean
num int N/A
Method Name getListFile Scope public
N/A None
N/A None N/A
Method Name getCurrentFolder Scope public
N/A File
N/A None N/A
Method Name findSizeMinFolder Scope private
N/A None
NFD<v0.1> 21
N/A None N/A
CompareController
Attributes
cmpComponent IComparator Reference to the
interfaceIComparator
Methods
Method Name doComparing Scope public
N/A None
N/A None N/A
CriterionController
Attributes
logs ArrayList Store the list of logs
lstCriterions HashMap<String, ICriterion> Store the list of
criterions
Methods
Method Name registerCriterion Scope public
N/A None
crt IDetailCriterion N/A
Method Name checkCriterion Scope public
N/A None
N/A None N/A
Method Name setCriterion Scope public
N/A None
num int N/A
DisplayController
Attributes
Rs Result Reference to the result
of compare process
Methods
Method Name displayStatus Scope public
N/A None
message String N/A
Method Name displayResult Scope public
N/A None
NFD<v0.1> 22

N/A None N/A
Method Name displayInfo Scope public
N/A None
N/A None N/A
Method Name enableDetail Scope public
N/A None
N/A None N/A
Method Name setEnableCancel Scope public
N/A None
enable boolean N/A
CompareThread
Attributes
t Thread Reference to the
thread
fdC ScanFolderController Reference to the scan
controller
cmpC CompareController Reference to the
compare controller
ctrC CriterionController Reference to the
criterion controller
dspT DisplayThread Reference to the
display thread
Methods
Method Name run Scope public
N/A None
N/A None N/A
Method Name start Scope public
N/A None
N/A None N/A
Method Name stop Scope public
N/A None
N/A None N/A
NFD<v0.1> 23
DisplayThread
Attributes
t Thread Reference to the
thread
dsp DisplayController Reference to the
display controller
Methods
Method Name run Scope public
N/A None
N/A None N/A
Method Name triggerNotify Scope public
N/A None
N/A None N/A
Method Name start Scope public
N/A None
N/A None N/A
Result
Attributes
newerFolder String Reference to the folder
result
newerPathFolder String The path of newer
folder
logs List<String> Reference to list logs
pathFolder1 String Path of the folder 1
pathFolder2 String Path of the folder 2
numFileOfFolder1 Int Number of files in
folder 1
numFileOfFolder2 Int Number of files in
folder 2
numSameFile Int Number of same files
in 2 folder
sizeMinFolder Int Size of the folder
whose fewer file
Methods
Method Name Scope
N/A None
N/A None N/A
NFD<v0.1> 24
Component diagram
Picture 17 Component diagram
ScanFolderLib
Picture 18 Component diagram-ScanFolderLib

NFD<v0.1> 25
Initiator
Attributes
Methods
Method Name init Scope public
A IfolderController - Create new instance Folder
Controller
Parameter Type Default Value
IFolderController
Attributes
Methods
Method Name openFolder Scope public
A Boolean Set info of current folder

Method Name getCurrentFolder Scope public

A File Get info of current Folder
Method Name getListFileOfFolder Scope public

A List<File> Get all file in folder
folder File
FolderController
Attributes
chooser JFileChooser Private
currentFolder File Private
lstFiles List<File> Private
Methods
Method Name getCurrentFolder Scope Public
A File Get current Folder Info
Method Name openFolder Scope Public
A boolean Set current Folder Info
Method Name getListFileOfFolder Scope Public
A List<File> Get List file in Folder
NFD<v0.1> 26

folder File
Method Name isTheSameAsFolder Scope Public
A boolean Check the same of folder
pathFolder String
Method Name getAllFilesInFolderToList Scope Private
N/A Get all file in folder to list of folder
folder File
Criterion1Lib
Picture 19 Component diagram-Criterion1Lib

NFD<v0.1> 27
Initiator
Attributes
N/A
Methods
A ICriterion Create new instance of ICriterion
ICriterion
Attributes
N/A
Methods
A boolean Check criterion of folder
lstFinalResul HashMap<String,
List<File[]>>
sizeMinFolder int
Methods
Method Name getLogs Scope public
A List<String>
Methods
Method Name getCriterion Scope public
A/A
IDetailCriterion
Attributes
nameCriterion String
Methods
Method Name String Scope public
A nameCriterion Create new instance of Criterion1
Methods
N/A
NFD<v0.1> 28
criterion int
Criterion1
Attributes
percentDefault Int
logs List<String>
newerFolder String
numSameFile int
Methods
Method Name Criterion1 Scope public
N/A
Methods
A Bollean
lstFinalResul HashMap<String, List<File[]>>
sizeMinFolder int
Methods
Method Name getLogs Scope public
A List<String>
Methods
A int
Methods
Method Name getNewerFolder Scope public
A String
Methods
Method Name getNumSameFile Scope public
A int
Methods
Method Name getCriterion Scope public
NFD<v0.1> 29
A IDetailCriterion
s
Methods
Method Name checkPercentCondition Scope public
A Boolean
sizeMinFolder int
Methods
Method Name checkIfAllFilesAreTheSameModifiedDate Scope public
A Boolean
lstFinalResuls HashMap<String, List<File[]>>
Methods
Method Name checkIfAnyFileIsTheNewest Scope public
A Boolean
lstFinalResul HashMassp<String, List<File[]>>
Methods
Method Name checkIfOneSideIsTotalNewer Scope public
A Boolean
NFD<v0.1> 30
CompareLib
Picture 20 Component diagram - CompareLib
CompareInitiator
Attributes
Methods
N/A IComparator Create new instance Comparator
IComparator
Attributes
NFD<v0.1> 31
Methods
Method Name startCompare Scope public
A HashMap<String, Compare two folder
List<File[]>>
dirMasterA String
dirMasterB String
fileList1 List<File>
fileList2 List<File>
Methods
Method Name stopCompare Scope public
N/A
Methods
Method Name pauseCompare Scope public
N/A
Methods
Method Name resumeCompare Scope public
N/A
Comparator
Attributes
Methods
Method Name getRelativePath Scope public
A Path Get Relative of file choosed.
children String
master String
Methods
Method Name startCompare Scope public
A HashMap<String, Get Relative of file choosed.
List<File[]>>
children String
master String
Methods
NFD<v0.1> 32
Method Name compareFiles Scope private

A HashMap<String, Compare two folder
List<File[]>>
dirMaster String
listFile String
map HashMap<String,
File>
order Int
Methods
Method Name stopCompare Scope public
N/A
Methods
Method Name pauseCompare Scope public
Parameter Void Default Value
Methods
Method Name resumeCompare Scope public
Parameter Void Default Value

Analysis and Design Document

Uploaded by

Document Information

Original Description:

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Analysis and Design Document

Uploaded by

Copyright:

Available Formats

NFD<v0.

ANALYSIS and DESIGN DOCUMENT

Picture 1 Use case diagram

NFD001- Configure compare criterion

Use Case ID: NFD001

Picture 2 Configure compare criterion

NFD002 - Choose folder

Use Case ID: NFD002

Alternative Courses: 1. Client clicks “Open Folder 1” button

Picture 3 Choose folders

NFD003 - Compare two folder

Use Case ID: NFD003

this action ( don't click "Save" button ) , system will show

Includes: View compared result.

Picture 4 compare two folder

NFD004 - Cancel compare process

Frequency of Use: Always

Picture 5 Cancel compare process

NFD005 - View compared result

Use Case ID: NFD005

Picture 6 View compared result

NFD006 - View compared detail

Use Case ID: NFD006

Picture 7 View compared detail

Analysis Class Diagram

Picture 8 Analysis Class Diagram

Class Responsibility and Collaboration

Configure compare criterion

Picture 9 Configure compare criterion

Picture 10 Choose folders

Compare two folders

Picture 11 Compare two folders

Cancel Compare Process

Picture 12 Cancel Compare Process

View compare result

Picture 13 View compare result

Picture 14 View Detail Result

Picture 15 State-Machine diagram

Picture 16 Class Specification

N/A None N/A

N/A None N/A

N/A None N/A

Parameter Type DefaultValue

Picture 17 Component diagram

Picture 18 Component diagram-ScanFolderLib

A Boolean Set info of current folder

Method Name getCurrentFolder Scope public

Method Name getListFileOfFolder Scope public

Parameter Type Default Value

Picture 19 Component diagram-Criterion1Lib

Picture 20 Component diagram - CompareLib

Method Name compareFiles Scope private

Parameter Void Default Value

Parameter Void Default Value

You might also like