USMFStatus (OpenIMAJ master project 1.3.1 API)

java.lang.Object
- org.openimaj.twitter.GeneralJSON
- - org.openimaj.twitter.USMFStatus

All Implemented Interfaces:

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

Direct Known Subclasses:

TrueLanguageTwitterStatus
```
public class USMFStatus
extends GeneralJSON
implements Cloneable
```
A USMFstatus. A java object representation of the Unified Social Media Format. This object can be empty constructed to do default reads from USMF JSON, or be given a GeneralJSON class for a JSON object it should expect to read from JSON and convert to USMF. Translation from alternative JSON sources relies on the extension of the GeneralJSON class for that format.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk), Sina Samangooei (ss@ecs.soton.ac.uk), Laurence Willmore (lgw1e10@ecs.soton.ac.uk)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`USMFStatus.Link` Container object for holding link information
`static class`	`USMFStatus.User` Container object to hold user information

Field Summary

Fields
Modifier and Type	Field and Description
`String`	`application` Application used to create this posting
`String`	`category` Category of content
`int`	`comments` Number of users who "commented" this
`String`	`country_code` the ISO A2 country code
`String`	`date` Date posted
`String`	`description` Full post text / Decription
`int`	`dislikes` Number of users who "disliked" this
`long`	`duration` Duration of content (if video)
`int`	`favorites` Number of users who "favorited" this
`double[]`	`geo` Latitude/Longitude content creation location
`long`	`id` Unique ID
`ArrayList<String>`	`keywords` Related Keywords
`int`	`likes` Number of users who "liked" this
`ArrayList<USMFStatus.Link>`	`links` List of links
`String`	`location` Plain Language content creation location
`int`	`max_rating` Maximum "rating" of content
`int`	`min_rating` Minimum "rating" of content
`int`	`rates` Number of users who "rated" this
`int`	`rating` Average "rating" of content
`USMFStatus.User`	`reply_to` Reply to
`String`	`service` Service Name
`String`	`source` User friendly link to content
`String`	`text` Microblog text / Video Title / Etc
`ArrayList<USMFStatus.User>`	`to_users` List of to users
`USMFStatus.User`	`user` User object for User Fields

Fields inherited from class org.openimaj.twitter.GeneralJSON
analysis, gson

Constructor Summary

Constructors
Constructor and Description
`USMFStatus()` Empty constructor for reading from USMF json strings.
`USMFStatus(Class<? extends GeneralJSON> generalJSONclass)` Constructor used if the input JSON is not a USMF json string.

Method Summary

Methods
Modifier and Type	Method and Description
`USMFStatus`	`clone()`
`<T extends USMFStatus> T`	`clone(Class<T> clazz)` Clones the tweet to the given class.
`org.joda.time.DateTime`	`createdAt()`
`boolean`	`equals(Object obj)`
`void`	`fillFromString(String line)` Used by readASCII(), and available for external use to fill this USMFStatus with the information held in the line
`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.
`void`	`fromUSMF(USMFStatus status)` This is the method that will be called to allow this object to fill itself from a USMF object.
`Class<? extends GeneralJSON>`	`getGeneralJSONClass()`
`GeneralJSON`	`instanceFromString(String line)`
`boolean`	`isInvalid()`
`void`	`readASCII(Scanner in)` Read internal state from in.
`void`	`setGeneralJSONClass(Class<? extends GeneralJSON> g)` set the type of json that backs this instance (used primarily for reading)
`String`	`toJson()`
`String`	`toString()`

Methods inherited from class org.openimaj.twitter.GeneralJSON
addAnalysis, analysisToJSON, asciiHeader, binaryHeader, fillAnalysis, getAnalysis, readBinary, writeASCII, writeASCIIAnalysis, writeASCIIAnalysis, writeBinary

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

- Field Detail
  - service
```
public String service
```
    Service Name
  - id
```
public long id
```
    Unique ID
  - geo
```
public double[] geo
```
    Latitude/Longitude content creation location
  - application
```
public String application
```
    Application used to create this posting
  - location
```
public String location
```
    Plain Language content creation location
  - date
```
public String date
```
    Date posted
  - source
```
public String source
```
    User friendly link to content
  - text
```
public String text
```
    Microblog text / Video Title / Etc
  - description
```
public String description
```
    Full post text / Decription
  - keywords
```
public ArrayList<String> keywords
```
    Related Keywords
  - category
```
public String category
```
    Category of content
  - duration
```
public long duration
```
    Duration of content (if video)
  - likes
```
public int likes
```
    Number of users who "liked" this
  - dislikes
```
public int dislikes
```
    Number of users who "disliked" this
  - favorites
```
public int favorites
```
    Number of users who "favorited" this
  - comments
```
public int comments
```
    Number of users who "commented" this
  - rates
```
public int rates
```
    Number of users who "rated" this
  - rating
```
public int rating
```
    Average "rating" of content
  - min_rating
```
public int min_rating
```
    Minimum "rating" of content
  - max_rating
```
public int max_rating
```
    Maximum "rating" of content
  - user
```
public USMFStatus.User user
```
    User object for User Fields
  - to_users
```
public ArrayList<USMFStatus.User> to_users
```
    List of to users
  - reply_to
```
public USMFStatus.User reply_to
```
    Reply to
  - links
```
public ArrayList<USMFStatus.Link> links
```
    List of links
  - country_code
```
public String country_code
```
    the ISO A2 country code
- Constructor Detail
  - USMFStatus
```
public USMFStatus(Class<? extends GeneralJSON> generalJSONclass)
```
    Constructor used if the input JSON is not a USMF json string.
    
    Parameters:
    generalJSONclass - : The class of the GeneralJSON extension.
  - USMFStatus
```
public USMFStatus()
```
    Empty constructor for reading from USMF json strings.
- Method Detail
  - getGeneralJSONClass
```
public Class<? extends GeneralJSON> getGeneralJSONClass()
```
    Returns:
    the type of json that backs this instance (used primarily for reading)
  - setGeneralJSONClass
```
public void setGeneralJSONClass(Class<? extends GeneralJSON> g)
```
    set the type of json that backs this instance (used primarily for reading)
    
    Parameters:
    g -
  - isInvalid
```
public boolean isInvalid()
```
    Returns:
    the USMF is either a delete notice, a scrub geo notice or some other non-status USMF
  - readASCII
```
public void readASCII(Scanner in)
               throws IOException
```
    Description copied from interface: ReadableASCII
    
    Read internal state from in.
    
    Specified by:
    
    readASCII in interface ReadableASCII
    
    Parameters:
    in - source to read from.
    
    Throws:
    
    IOException - an error reading input
  - fillFromString
```
public void fillFromString(String line)
```
    Used by readASCII(), and available for external use to fill this USMFStatus with the information held in the line
    
    Parameters:
    line - = json string in the format specified by the constructor of this USMFStatus (if empty constructor, expects a USMFSStatus json string)
  - instanceFromString
```
public GeneralJSON instanceFromString(String line)
```
    Specified by:
    
    instanceFromString in class GeneralJSON
    
    Returns:
    construct an instance of this type from a string
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toJson
```
public String toJson()
```
    Returns:
    convert this USMFStatus to JSON using Gson
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - clone
```
public USMFStatus clone()
```
    Overrides:
    
    clone in class Object
  - clone
```
public <T extends USMFStatus> T clone(Class<T> clazz)
```
    Clones the tweet to the given class.
    
    Type Parameters:
    T -
    Parameters:
    clazz -
    
    Returns:
    a clone of the status
  - createdAt
```
public org.joda.time.DateTime createdAt()
                                 throws ParseException
```
    Returns:
    get the created_at date as a java date
    
    Throws:
    
    ParseException
  - fillUSMF
```
public void fillUSMF(USMFStatus status)
```
    Description copied from class: GeneralJSON
    
    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.
    
    Specified by:
    
    fillUSMF in class GeneralJSON
    
    Parameters:
    status - = USMFStatus to be filled
  - fromUSMF
```
public void fromUSMF(USMFStatus status)
```
    Description copied from class: GeneralJSON
    
    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
    
    Specified by:
    
    fromUSMF in class GeneralJSON
    
    Parameters:
    status - = USMFStatus to be filled

Class USMFStatus

Nested Class Summary

Field Summary

Fields inherited from class org.openimaj.twitter.GeneralJSON

Constructor Summary

Method Summary

Methods inherited from class org.openimaj.twitter.GeneralJSON

Methods inherited from class java.lang.Object

Field Detail

service

id

geo

application

location

date

source

text

description

keywords

category

duration

likes

dislikes

favorites

comments

rates

rating

min_rating

max_rating

user

to_users

reply_to

links

country_code

Constructor Detail

USMFStatus

USMFStatus

Method Detail

getGeneralJSONClass

setGeneralJSONClass

isInvalid

readASCII

fillFromString

instanceFromString

toString

toJson

equals

clone

clone

createdAt

fillUSMF

fromUSMF