TemplateJSONRetriever

java.lang.Object
- com.purplehillsbooks.temps.TemplateJSONRetriever

All Implemented Interfaces:

TemplateTokenRetriever
```
public class TemplateJSONRetriever
extends java.lang.Object
implements TemplateTokenRetriever
```
This is a TemplateStreamer that gets all the information for the tokens from JSON object tree. The token values are expressed as path expressions with dots between them. For example, for a JSON structure like this:
```
 {
     cust: [
       {
         address: {
             street: "666 bottom row",
             city: "Pittsburg"
         },
         name: "Jones"
       },
       {
         address: {
             street: "1 Elm St.",
             city: "Highland Park"
         },
         name: "Smith"
       }
     ]
 }


   cust.0.name            == Jones
   cust.1.name            == Smith
   cust.1.address.street  == 1 Elm St.

 
```
Expressions that accurately address leaf nodes will write that string value If the leaf is a number it will write a string representation of that. If the expression ends at an object or an array, it will write nothing. If the expression addresses a member that does not exist, it writes nothing.

Constructor Summary

Constructors
Constructor and Description

TemplateJSONRetriever(JSONObject _data)

Constructors
Constructor and Description
`TemplateJSONRetriever(JSONObject _data)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`closeLoop(java.lang.String id)` When a loop is finished, this is called so that the id can be freed up and references to this id value will no longer work.
`void`	`debugDump(java.io.Writer out)` Produce an output which represents all of the tokens that can be used in the current template given the specific context.
`boolean`	`ifValue(java.lang.String token)` Looks at the value specified, and returns boolean scalar: true means for a scalar that there is a value there, and that the value is not 0, false, or null.
`int`	`initLoop(java.lang.String id, java.lang.String token)` A loop has an identifier which functions as the iterated data item, and a token which refers to the array that you are iterating over.
`static int`	`safeConvertInt(java.lang.String val)` designed primarily for returning date long values works only for positive integer (long) values considers all numeral, ignores all letter and punctuation never throws an exception if you give this something that is not a number, you get surprising result.
`static long`	`safeConvertLong(java.lang.String val)`
`void`	`setIteration(java.lang.String id, int loopCount)` Before each time through a loop, this will be called to say which iteration of the loop it is in, and therevore which index element of the chosen array (see initLoop) should be accessed
`static java.util.ArrayList<java.lang.String>`	`splitDots(java.lang.String val)` Breaks a string into a list of strings using dots (periods) as separators of the token, and trimming each token of spaces if there are any.
`void`	`writeTokenDate(java.io.Writer out, java.lang.String token, java.lang.String format)` token specifies a date, and this will format the date for inclusion in the form using the format specified in the last parameter.
`void`	`writeTokenValue(java.io.Writer out, java.lang.String token)` The token passed will be all text between the double curly brace delimiter.
`void`	`writeTokenValueRaw(java.io.Writer out, java.lang.String token)` List writeTokenValue, but without the HTML encoding.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TemplateJSONRetriever
```
public TemplateJSONRetriever(JSONObject _data)
```
- Method Detail
  - writeTokenValue
```
public void writeTokenValue(java.io.Writer out,
                            java.lang.String token)
                     throws java.lang.Exception
```
    Description copied from interface: TemplateTokenRetriever
    
    The token passed will be all text between the double curly brace delimiter. This method must determine what associated value is, and write it out. The token can be as complicated an expressions as you want, but it can not have any curly brace characters in it anywhere. You might have a token with multiple parameters as long as you parse out the parameters and recognize their values. If your implementation recognizes the token, then write the value, properly encoded, to the output stream. If the template is HTML, then remember to encode the value using HTML encoding, perhaps by using the TemplateStreamer.writeHtml() function. If you are not sure that the value needs encoding, then encode anyway, because it will eliminate many forms of hacking attacks. Note: throwing an exception from this will cause the streaming of the rest of the template to stop.
    
    Specified by:
    
    writeTokenValue in interface TemplateTokenRetriever
    
    Throws:
    
    java.lang.Exception
  - writeTokenValueRaw
```
public void writeTokenValueRaw(java.io.Writer out,
                               java.lang.String token)
                        throws java.lang.Exception
```
    Description copied from interface: TemplateTokenRetriever
    
    List writeTokenValue, but without the HTML encoding. Used to include preformatted HTML into the output. BUt be careful, this can be dangerous.
    
    Specified by:
    
    writeTokenValueRaw in interface TemplateTokenRetriever
    
    Throws:
    
    java.lang.Exception
  - writeTokenDate
```
public void writeTokenDate(java.io.Writer out,
                           java.lang.String token,
                           java.lang.String format)
                    throws java.lang.Exception
```
    Description copied from interface: TemplateTokenRetriever
    
    token specifies a date, and this will format the date for inclusion in the form using the format specified in the last parameter.
    
    Specified by:
    
    writeTokenDate in interface TemplateTokenRetriever
    
    Throws:
    
    java.lang.Exception
  - initLoop
```
public int initLoop(java.lang.String id,
                    java.lang.String token)
             throws java.lang.Exception
```
    Description copied from interface: TemplateTokenRetriever
    
    A loop has an identifier which functions as the iterated data item, and a token which refers to the array that you are iterating over. The id passed was specified by the user, and it will serve as a variable that can access the iterated object. This id value may be passed as a token in a regular data write token, so the TTR must remember this id, and check first for this. There could be any number of levels of loops, each one must have a unique id.
    
    Specified by:
    
    initLoop in interface TemplateTokenRetriever
    
    Throws:
    
    java.lang.Exception
  - setIteration
```
public void setIteration(java.lang.String id,
                         int loopCount)
                  throws java.lang.Exception
```
    Description copied from interface: TemplateTokenRetriever
    
    Before each time through a loop, this will be called to say which iteration of the loop it is in, and therevore which index element of the chosen array (see initLoop) should be accessed
    
    Specified by:
    
    setIteration in interface TemplateTokenRetriever
    
    Throws:
    
    java.lang.Exception
  - closeLoop
```
public void closeLoop(java.lang.String id)
               throws java.lang.Exception
```
    Description copied from interface: TemplateTokenRetriever
    
    When a loop is finished, this is called so that the id can be freed up and references to this id value will no longer work.
    
    Specified by:
    
    closeLoop in interface TemplateTokenRetriever
    
    Throws:
    
    java.lang.Exception
  - ifValue
```
public boolean ifValue(java.lang.String token)
                throws java.lang.Exception
```
    Description copied from interface: TemplateTokenRetriever
    
    Looks at the value specified, and returns boolean scalar: true means for a scalar that there is a value there, and that the value is not 0, false, or null. false means it is missing, empty, null, 0, or nullstring. array: true means there is one or more entries false means either it is missing, or it has no entries
    
    Specified by:
    
    ifValue in interface TemplateTokenRetriever
    
    Throws:
    
    java.lang.Exception
  - debugDump
```
public void debugDump(java.io.Writer out)
               throws java.lang.Exception
```
    Description copied from interface: TemplateTokenRetriever
    
    Produce an output which represents all of the tokens that can be used in the current template given the specific context. In other words make a dump of all the data values right now so we know what values can be used in the tokens.
    
    Specified by:
    
    debugDump in interface TemplateTokenRetriever
    
    Throws:
    
    java.lang.Exception
  - safeConvertInt
```
public static int safeConvertInt(java.lang.String val)
```
    designed primarily for returning date long values works only for positive integer (long) values considers all numeral, ignores all letter and punctuation never throws an exception if you give this something that is not a number, you get surprising result. Zero if no numerals at all.
  - safeConvertLong
```
public static long safeConvertLong(java.lang.String val)
```
  - splitDots
```
public static java.util.ArrayList<java.lang.String> splitDots(java.lang.String val)
```
    Breaks a string into a list of strings using dots (periods) as separators of the token, and trimming each token of spaces if there are any.

Class TemplateJSONRetriever

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TemplateJSONRetriever

Method Detail

writeTokenValue

writeTokenValueRaw

writeTokenDate

initLoop

setIteration

closeLoop

ifValue

debugDump

safeConvertInt

safeConvertLong

splitDots