Difference between revisions of "JSON Integration Adapter Code Review 1 Changes"

From CDOT Wiki
Jump to: navigation, search
m (→‎JSONMessagePartMapping)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
{{Admon/obsolete}}
 +
 
[[category: NexJ Express JSON Message Adapter]]
 
[[category: NexJ Express JSON Message Adapter]]
  
Line 10: Line 12:
 
* Create localization strings in en.strings
 
* Create localization strings in en.strings
 
* Use message part as argument to exceptions and not the whole message
 
* Use message part as argument to exceptions and not the whole message
−
|  
+
| Complete for formatter, may be revisited for parser
 
|-  
 
|-  
 
| Documentation
 
| Documentation
Line 21: Line 23:
 
* Lines that create new Objects should be between newlines
 
* Lines that create new Objects should be between newlines
 
* Add newline before break  
 
* Add newline before break  
 +
| Complete for now (revisit later)
 
|}
 
|}
  
Line 32: Line 35:
 
* Replace screenshots of Messages with valid messages (some values where missing type)
 
* Replace screenshots of Messages with valid messages (some values where missing type)
 
* Make note of any normally standard features which are not implemented by the JSON parser/formatter
 
* Make note of any normally standard features which are not implemented by the JSON parser/formatter
−
|
+
* Add section about required parts and null values
 +
* Add section about channels with multiple messages
 +
| Complete
 
|}
 
|}
  
Line 76: Line 81:
 
| InvocationContextAware
 
| InvocationContextAware
 
* Do not implement the invocation context aware interface if not used by the class
 
* Do not implement the invocation context aware interface if not used by the class
−
|  
+
| Complete
 
|-  
 
|-  
 
| Rename methods XXXNode to XXXPart
 
| Rename methods XXXNode to XXXPart
−
|  
+
| Complete
 
|-  
 
|-  
 
| fail
 
| fail
−
1. Wrap fail so that is throws expection right away
+
1. Wrap fail so that is throws expection right away<br>
 
2. Move fail statements from bottom to top, remove else clauses  
 
2. Move fail statements from bottom to top, remove else clauses  
−
| 1. Complete 2. Incomplete
+
| 1. Complete <br>
 +
2. Incomplete
 
|-  
 
|-  
 
| parse()
 
| parse()
Line 92: Line 98:
 
| parsing primitive values
 
| parsing primitive values
 
* Use primitive formatter on values that are parsed before storing them
 
* Use primitive formatter on values that are parsed before storing them
−
|  
+
| Complete
 
|}
 
|}
  

Latest revision as of 19:52, 26 January 2014

Important.png
This page may be obsolete.
It contains historical information.
General
Tasks Status
Exception
  • Create localization strings in en.strings
  • Use message part as argument to exceptions and not the whole message
 Complete for formatter, may be revisited for parser
Documentation
  • Add documentation to all methods and members
  • Use full English sentences
Code Style
  • Apply NexJ Code Style
  • Lines that create new Objects should be between newlines
  • Add newline before break
Complete for now (revisit later)
Design Document
Task Status
Update Design Proposal Document
  • Replace screenshots of Messages with valid messages (some values where missing type)
  • Make note of any normally standard features which are not implemented by the JSON parser/formatter
  • Add section about required parts and null values
  • Add section about channels with multiple messages
 Complete
JSONMessagePartMapping
Task Status
Use Hashholder instead of HashSet Complete
byte initialization
  • Remove leading zeros
 Complete
StringParser
  • Remove if not needed
 Complete
RootJSONMessagePartMapping
  • Create class RootJSONMessagePartMapping
  • Extend JSONMessagePartMapping and move all root settings to this.
 Complete
Composite Message Part modes
  • Rename root mode to mode
  • Allow all composite message parts to have a mode
 Complete
m_sFormat
  • Remove if not needed
 Complete
JSONMessageParser
Task Status
InvocationContextAware
  • Do not implement the invocation context aware interface if not used by the class
 Complete
Rename methods XXXNode to XXXPart Complete
fail

1. Wrap fail so that is throws expection right away
2. Move fail statements from bottom to top, remove else clauses

1. Complete

2. Incomplete

parse()
  • Override parse method of JSONParser to always return a TransferObject
parsing primitive values
  • Use primitive formatter on values that are parsed before storing them
 Complete
JSONMessageFormatter
Task Status
Format primitive values
  • Make of use of mapping.getFormat()
 Complete
Pass enumerations into formatMessageRoot
  • Do not use member/class variables for storing information unless absolutely necessary
 Complete
Retrieved from "https://wiki.cdot.senecapolytechnic.ca/w/index.php?title=JSON_Integration_Adapter_Code_Review_1_Changes&oldid=104113"