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

From CDOT Wiki
Jump to: navigation, search
m (Design Document)
m (General)
Line 10: Line 10:
 
* 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
| In Progress
+
| Complete for formatter, may be revisited for parser
 
|-  
 
|-  
 
| Documentation
 
| Documentation

Revision as of 10:37, 24 August 2011


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
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
In Progress
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
Rename methods XXXNode to XXXPart
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
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