winterwell.jtwitter

Class InternalUtils

java.lang.Object

winterwell.jtwitter.InternalUtils

public class InternalUtils
extends java.lang.Object

Utility methods used in Twitter. This class is public in case anyone else wants to use these methods. WARNING: they don't really form part of the JTwitter API, and may be changed or reorganised in future versions.

NB: Some of these are copies (sometimes simplified) of methods in com.winterwell.utils.Utils You can find this code here: https://github.com/sodash/open-code

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.regex.Pattern	DM Group 1 = the recipient
static long	HOUR one hour in milliseconds
static java.util.regex.Pattern	latLongLocn Matches latitude, longitude, including with the UberTwitter UT: prefix Group 2 = latitude, Group 3 = longitude.
static java.util.regex.Pattern	pComment Matches an xml comment - including some bad versions
static java.util.regex.Pattern	pDocType Matches a doctype element.
static java.util.regex.Pattern	pScriptOrStyle Used in strip tags to get rid of scripts and css style blocks altogether.
static java.util.regex.Pattern	REGEX_JUST_DIGITS
static java.util.regex.Pattern	TAG_REGEX

Constructor Summary

Constructors

Constructor and Description
InternalUtils()

Method Summary

Modifier and Type	Method and Description
static java.math.BigInteger	addTimeToStatusId(java.math.BigInteger statusId, long time) Splits a Twitter Snowflake ID into its component numbers, performs arithmetic on the timestamp component, and reconstitutes a synthetic ID for "since_id" and "until_id" purposes.
static java.util.Map	asMap(java.lang.Object... keyValuePairs) Create a map from a list of key, value pairs.
static void	close(java.io.Closeable output)
static void	close(java.io.InputStream input)
static java.util.Map<com.winterwell.jgeoplanet.IPlace,java.lang.Double>	filterByReq(com.winterwell.jgeoplanet.GeoCodeQuery query, java.util.Map<com.winterwell.jgeoplanet.IPlace,java.lang.Double> places) Utility method for IGeoCoders
static java.lang.Boolean	geoMatch(com.winterwell.jgeoplanet.GeoCodeQuery query, com.winterwell.jgeoplanet.IPlace place) Does place match the query?
static java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Long>	getAPIUsageStats() Deprecated.
static <X> X	getBest(java.util.Map<X,java.lang.Double> places) Best of them, or null if places is empty
static java.util.Date	getDate(int year, java.lang.String month, int day) Convenience method for making Dates.
static java.util.Date	getMaxDate(java.util.List<? extends Twitter.ITweet> stati)
static java.math.BigInteger	getMinId(java.math.BigInteger maxId, java.util.List<? extends Twitter.ITweet> stati)
static java.lang.String	join(java.lang.String[] screenNames) Join the list
protected static java.lang.String	jsonGet(java.lang.String key, com.winterwell.json.JSONObject jsonObj) Helper method to deal with JSON-in-Java weirdness
static void	log(java.lang.String tag, java.lang.Object msg) Use the Winterwell logger.
static java.lang.Object	or(java.lang.Object... bits)
static java.util.Map<com.winterwell.jgeoplanet.IPlace,java.lang.Double>	prefer(com.winterwell.jgeoplanet.GeoCodeQuery query, java.util.List<? extends com.winterwell.jgeoplanet.IPlace> places, java.lang.String prefType, double baseConfidence) Utility method for IGeoCoders
protected static java.lang.String	read(java.io.InputStream inputStream) Use a buffered reader (preferably UTF-8) to extract the contents of the given stream.
static java.lang.String	removePunctuation(java.lang.String string)
static void	setTrackAPIUsage(boolean on) Deprecated.
static void	sleep(long msecs)
static java.lang.String	str(java.lang.Object obj) Created to handle odd failed toString() for Exception: "[Ljava.lang.StackTraceElement;@6553bf22" Seen Dec 2014
static java.lang.String	str(java.lang.Object[] array)
static java.lang.String	stripTags(java.lang.String xml) Remove xml and html tags, e.g.
static java.lang.String	stripUrls(java.lang.String text) Deprecated. Not used anymore
static java.math.BigInteger	toBigInteger(java.lang.Number statusId)
static java.lang.String	toCanonical(java.lang.String string)
static java.lang.String	toString(java.lang.Throwable x, boolean stacktrace) Copied from Printer in utils
static java.lang.String	trimPunctuation(java.lang.String string) Trim out whitespace and punctuation from the beginning and end of the string.
static java.lang.String	urlEncode(java.lang.String x) URL encode

Methods inherited from class java.lang.Object

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

Field Detail

TAG_REGEX

public static final java.util.regex.Pattern TAG_REGEX

latLongLocn

public static final java.util.regex.Pattern latLongLocn

Matches latitude, longitude, including with the UberTwitter UT: prefix Group 2 = latitude, Group 3 = longitude.

Weird: I saw this as an address - "ÜT: 25.324488,55.376224t" Is it just a one-off typo? Should we match N/S/E/W markers?

REGEX_JUST_DIGITS

public static final java.util.regex.Pattern REGEX_JUST_DIGITS

DM

public static final java.util.regex.Pattern DM

Group 1 = the recipient

pComment

public static final java.util.regex.Pattern pComment

Matches an xml comment - including some bad versions

pScriptOrStyle

public static final java.util.regex.Pattern pScriptOrStyle

Used in strip tags to get rid of scripts and css style blocks altogether.

pDocType

public static final java.util.regex.Pattern pDocType

Matches a doctype element.

HOUR

public static final long HOUR

one hour in milliseconds

See Also:

Constant Field Values

Constructor Detail

InternalUtils

public InternalUtils()

Method Detail

setTrackAPIUsage

@Deprecated
public static void setTrackAPIUsage(boolean on)

Deprecated.

getAPIUsageStats

@Deprecated
public static java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Long> getAPIUsageStats()

Deprecated.

filterByReq

public static java.util.Map<com.winterwell.jgeoplanet.IPlace,java.lang.Double> filterByReq(com.winterwell.jgeoplanet.GeoCodeQuery query,
                                                                                           java.util.Map<com.winterwell.jgeoplanet.IPlace,java.lang.Double> places)

Utility method for IGeoCoders

Parameters:

query -

places - Can be null.

Returns:

places which match the query requirements. Can be empty, never null.

prefer

public static java.util.Map<com.winterwell.jgeoplanet.IPlace,java.lang.Double> prefer(com.winterwell.jgeoplanet.GeoCodeQuery query,
                                                                                      java.util.List<? extends com.winterwell.jgeoplanet.IPlace> places,
                                                                                      java.lang.String prefType,
                                                                                      double baseConfidence)

Utility method for IGeoCoders

Parameters:

query -

places -

prefType - e.g. city

baseConfidence -

Returns:

stripUrls

public static java.lang.String stripUrls(java.lang.String text)

Deprecated. Not used anymore

Parameters:

text -

Returns:

text with any urls (using Twitter's Regex.VALID_URL) replaced with ""

asMap

public static java.util.Map asMap(java.lang.Object... keyValuePairs)

Create a map from a list of key, value pairs. An easy way to make small maps, basically the equivalent of Arrays.asList(Object...). If the value is null, the key will not be included.

close

public static void close(java.io.Closeable output)

close

public static void close(java.io.InputStream input)

getDate

public static java.util.Date getDate(int year,
                                     java.lang.String month,
                                     int day)

Convenience method for making Dates. Because Date is a tricksy bugger of a class.

Parameters:

year -

month -

day -

Returns:

date object

join

public static java.lang.String join(java.lang.String[] screenNames)

Join the list

Parameters:

screenNames -

Returns:

jsonGet

protected static java.lang.String jsonGet(java.lang.String key,
                                          com.winterwell.json.JSONObject jsonObj)

Helper method to deal with JSON-in-Java weirdness

Returns:

Can be null

read

protected static java.lang.String read(java.io.InputStream inputStream)

Use a buffered reader (preferably UTF-8) to extract the contents of the given stream. Then close it.

urlEncode

public static java.lang.String urlEncode(java.lang.String x)

URL encode

Parameters:

x - can be null (returns ""). Will be turned into a String using String.valueOf()

stripTags

public static java.lang.String stripTags(java.lang.String xml)

Remove xml and html tags, e.g. to safeguard against javascript injection attacks, or to get plain text for NLP.

Parameters:

xml - can be null, in which case null will be returned

Returns:

the text contents - ie input with all tags removed

sleep

public static void sleep(long msecs)

getMinId

public static java.math.BigInteger getMinId(java.math.BigInteger maxId,
                                            java.util.List<? extends Twitter.ITweet> stati)

Parameters:

maxId -

stati -

Returns:

mimimum - 1

getMaxDate

public static java.util.Date getMaxDate(java.util.List<? extends Twitter.ITweet> stati)

Parameters:

maxId -

stati -

Returns:

max date, or null if stati is empty

getBest

public static <X> X getBest(java.util.Map<X,java.lang.Double> places)

Best of them, or null if places is empty

Parameters:

places -

Returns:

geoMatch

public static java.lang.Boolean geoMatch(com.winterwell.jgeoplanet.GeoCodeQuery query,
                                         com.winterwell.jgeoplanet.IPlace place)

Does place match the query?

Parameters:

query -

place -

Returns:

true/false/null. Often null for unsure!

toCanonical

public static java.lang.String toCanonical(java.lang.String string)

log

public static void log(java.lang.String tag,
                       java.lang.Object msg)

Use the Winterwell logger. Reflection-based to avoid a dependency.

Parameters:

tag -

msg -

toBigInteger

public static java.math.BigInteger toBigInteger(java.lang.Number statusId)

Parameters:

statusId - Can be null (returns null)

Returns:

str

public static java.lang.String str(java.lang.Object[] array)

str

public static java.lang.String str(java.lang.Object obj)

Created to handle odd failed toString() for Exception: "[Ljava.lang.StackTraceElement;@6553bf22" Seen Dec 2014

Parameters:

obj -

Returns:

toString

public static java.lang.String toString(java.lang.Throwable x,
                                        boolean stacktrace)

Copied from Printer in utils

Parameters:

x -

stacktrace -

Returns:

or

public static java.lang.Object or(java.lang.Object... bits)

addTimeToStatusId

public static java.math.BigInteger addTimeToStatusId(java.math.BigInteger statusId,
                                                     long time)

Splits a Twitter Snowflake ID into its component numbers, performs arithmetic on the timestamp component, and reconstitutes a synthetic ID for "since_id" and "until_id" purposes. Last open-source release of the Snowflake spec: https://github.com/twitter/snowflake/releases/tag/snowflake-2010

Parameters:

time - A signed integer - milliseconds to add or subtract from the time. Can be null.

Returns:

A synthetic status ID (which does not necessarily correspond to a tweet) {time} msec in the future or past compared to statusId. Or null if the input was null.

trimPunctuation

public static java.lang.String trimPunctuation(java.lang.String string)

Trim out whitespace and punctuation from the beginning and end of the string.

Parameters:

string -

Returns:

removePunctuation

public static java.lang.String removePunctuation(java.lang.String string)