org.openimaj.twitter

Class GeneralJSON

java.lang.Object

org.openimaj.twitter.GeneralJSON

All Implemented Interfaces:

Readable, ReadableASCII, ReadableBinary, ReadWriteable, Writeable, WriteableASCII, WriteableBinary

Direct Known Subclasses:

GeneralJSONRDF, GeneralJSONTwitter, USMFStatus

public abstract class GeneralJSON
extends Object
implements ReadWriteable

This interface should be implemented by classes that will define a new json input format for the USMFStatus object. This object will be populated by GSon which fills the fields of the object with the matching named values in a json string structure. It is up to the extending programmer to implement their object so that it is accurately filled by GSon. See more here http://code.google.com/p/google-gson/

Author:

Laurence Willmore

Field Summary

Fields

Modifier and Type	Field and Description
Map<String,Object>	analysis analysos held in the object
protected static com.google.gson.Gson	gson

Constructor Summary

Constructors

Constructor and Description
GeneralJSON()

Method Summary

Methods

Modifier and Type	Method and Description
<T> void	addAnalysis(String annKey, T annVal) Add analysis to the analysis object.
String	analysisToJSON() Get all the Analysis in JSON format.
String	asciiHeader() Header for ascii input.
byte[]	binaryHeader() Header for binary input.
void	fillAnalysis(GeneralJSON other)
abstract void	fillUSMF(USMFStatus status) This is the method that will be called by USMFStatus to fill itself with the matching values from the extending class.
abstract void	fromUSMF(USMFStatus status) This is the method that will be called to allow this object to fill itself from a USMF object.
<T> T	getAnalysis(String name)
abstract GeneralJSON	instanceFromString(String line)
void	readBinary(DataInput in) Read internal state from in.
void	writeASCII(PrintWriter out) Write the content of this as ascii to out.
void	writeASCIIAnalysis(PrintWriter outputWriter, List<String> selectiveAnalysis) Convenience to allow writing of just the analysis to a writer
void	writeASCIIAnalysis(PrintWriter outputWriter, List<String> selectiveAnalysis, List<String> selectiveStatus) Convenience to allow writing of just the analysis and some status information to a writer
void	writeBinary(DataOutput out) Write the content of this as binary to out.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openimaj.io.ReadableASCII

readASCII

Field Detail

gson

protected static transient com.google.gson.Gson gson

analysis

public Map<String,Object> analysis

analysos held in the object

Constructor Detail

GeneralJSON

public GeneralJSON()

Method Detail

fillUSMF

public abstract void fillUSMF(USMFStatus status)

This is the method that will be called by USMFStatus to fill itself with the matching values from the extending class. It is up to the extending programmer to carry this out as they see fit. See GeneralJSONTwitter for a Twitter example.

Parameters:

status - = USMFStatus to be filled

fromUSMF

public abstract void fromUSMF(USMFStatus status)

This is the method that will be called to allow this object to fill itself from a USMF object. Implementations must guarantee that they hold on and copy internal ANALYSIS. we recommend the helper function

Parameters:

status - = USMFStatus to be filled

readBinary

public void readBinary(DataInput in)
                throws IOException

Description copied from interface: ReadableBinary

Read internal state from in.

Specified by:

readBinary in interface ReadableBinary

Parameters:

in - source to read from.

Throws:

IOException - an error reading input

binaryHeader

public byte[] binaryHeader()

Description copied from interface: ReadableBinary

Header for binary input. Will be automatically read by IOUtils when using readBinary().

Specified by:

binaryHeader in interface ReadableBinary

Specified by:

binaryHeader in interface WriteableBinary

Returns:

header

writeBinary

public void writeBinary(DataOutput out)
                 throws IOException

Description copied from interface: WriteableBinary

Write the content of this as binary to out.

Specified by:

writeBinary in interface WriteableBinary

Parameters:

out - sink to write to

Throws:

IOException - an error writing to out

asciiHeader

public String asciiHeader()

Description copied from interface: ReadableASCII

Header for ascii input. Will be automatically read by IOUtils when using readASCII().

Specified by:

asciiHeader in interface ReadableASCII

Specified by:

asciiHeader in interface WriteableASCII

Returns:

header

writeASCII

public void writeASCII(PrintWriter out)
                throws IOException

Description copied from interface: WriteableASCII

Write the content of this as ascii to out.

Specified by:

writeASCII in interface WriteableASCII

Parameters:

out - sink to write to

Throws:

IOException - an error writing to out

writeASCIIAnalysis

public void writeASCIIAnalysis(PrintWriter outputWriter,
                      List<String> selectiveAnalysis)

Convenience to allow writing of just the analysis to a writer

Parameters:

outputWriter -

selectiveAnalysis -

writeASCIIAnalysis

public void writeASCIIAnalysis(PrintWriter outputWriter,
                      List<String> selectiveAnalysis,
                      List<String> selectiveStatus)

Convenience to allow writing of just the analysis and some status information to a writer

Parameters:

outputWriter -

selectiveAnalysis -

selectiveStatus -

addAnalysis

public <T> void addAnalysis(String annKey,
                   T annVal)

Add analysis to the analysis object. This is where all non twitter stuff should go

Type Parameters:

T - The type of data being saved

Parameters:

annKey - the key

annVal - the value

getAnalysis

public <T> T getAnalysis(String name)

Type Parameters:

T -

Parameters:

name -

Returns:

the analysis under the name

analysisToJSON

public String analysisToJSON()

Get all the Analysis in JSON format.

Returns:

String of JSON.

fillAnalysis

public void fillAnalysis(GeneralJSON other)

Parameters:

other -

instanceFromString

public abstract GeneralJSON instanceFromString(String line)

Parameters:

line -

Returns:

construct an instance of this type from a string