A B C D E F G I J L M N O Q R S T U W

A

add(Filter) - Method in class com.factual.driver.FilterGroup

add(Filter) - Method in class com.factual.driver.Query

Adds filter to this Query.

add(String, Object) - Method in class com.factual.driver.ResolveQuery

and(Query...) - Method in class com.factual.driver.Query

Used to nest AND'ed predicates.

asOR() - Method in class com.factual.driver.FilterGroup

Sets this FilterGroup's logic to be OR.

B

beginsWith(String) - Method in class com.factual.driver.QueryBuilder

beginsWithAny(Object...) - Method in class com.factual.driver.QueryBuilder

blank() - Method in class com.factual.driver.QueryBuilder

C

Circle - Class in com.factual.driver

Represents a geographic sub query confining results to a circle.

Circle(double, double, int) - Constructor for class com.factual.driver.Circle

Constructs a geographic Circle representation.

Circle(Coord, int) - Constructor for class com.factual.driver.Circle

ColumnSchema - Class in com.factual.driver

ColumnSchema(Map<String, Object>) - Constructor for class com.factual.driver.ColumnSchema

Constructor.

com.factual.data_science_toolkit - package com.factual.data_science_toolkit

com.factual.driver - package com.factual.driver

Coord - Class in com.factual.data_science_toolkit

Represents a coordinate that came from a DataScienceToolkit query.

Coord(JSONObject) - Constructor for class com.factual.data_science_toolkit.Coord

Constructs a Coord from , which is expected to be a marshalled JSON object from a DataScienceToolkit query for a coord.

criteria(String) - Method in class com.factual.driver.Query

Deprecated. use Query.field(String)

Crosswalk - Class in com.factual.driver

Represents a Crosswalk record from Factual.

Crosswalk() - Constructor for class com.factual.driver.Crosswalk

CrosswalkQuery - Class in com.factual.driver

Represents a Factual Crosswalk query.

CrosswalkQuery() - Constructor for class com.factual.driver.CrosswalkQuery

CrosswalkResponse - Class in com.factual.driver

Represents the response from running a Crosswalk lookup against Factual.

CrosswalkResponse(String) - Constructor for class com.factual.driver.CrosswalkResponse

Constructor, parses from a JSON response String.

crosswalks(String, CrosswalkQuery) - Method in class com.factual.driver.Factual

Convenience method to return Crosswalks for the specific query.

D

data(JSONArray) - Static method in class com.factual.driver.JsonUtil

Takes a JSONArray of records, where each record is a dictionary, and returns the translated List of Maps.

DataScienceToolkit - Class in com.factual.data_science_toolkit

Provides a wrapper to Data Science Toolkit's public API.

DataScienceToolkit() - Constructor for class com.factual.data_science_toolkit.DataScienceToolkit

datatype - Variable in class com.factual.driver.ColumnSchema

description - Variable in class com.factual.driver.ColumnSchema

E

equal(Object) - Method in class com.factual.driver.QueryBuilder

F

faceted - Variable in class com.factual.driver.ColumnSchema

Factual - Class in com.factual.driver

Represents the public Factual API.

Factual(String, String) - Constructor for class com.factual.driver.Factual

Constructor.

FactualApiException - Exception in com.factual.driver

Represents an Exception that happened while communicating with Factual.

FactualApiException(Exception) - Constructor for exception com.factual.driver.FactualApiException

FactualApiException(String) - Constructor for exception com.factual.driver.FactualApiException

factualId(String) - Method in class com.factual.driver.CrosswalkQuery

Adds the specified Factual ID to this Query.

fetch(String, Query) - Method in class com.factual.driver.Factual

Runs a read query against the specified Factual table.

fetch(String, CrosswalkQuery) - Method in class com.factual.driver.Factual

Query's Factual for the Crosswalk data matching the specified query.

fetch(String, ResolveQuery) - Method in class com.factual.driver.Factual

Asks Factual to resolve the entity for the attributes specified by query, within the table called tableName.

field(String) - Method in class com.factual.driver.Query

Begins construction of a new row filter for this Query.

FieldFilter - Class in com.factual.driver

FieldFilter(String, String, Object) - Constructor for class com.factual.driver.FieldFilter

Filter - Interface in com.factual.driver

FilterGroup - Class in com.factual.driver

Represents a group of Filters as one Filter.

FilterGroup(List<Filter>) - Constructor for class com.factual.driver.FilterGroup

Constructor.

FilterGroup(Filter...) - Constructor for class com.factual.driver.FilterGroup

Constructor.

first() - Method in class com.factual.driver.CrosswalkResponse

first() - Method in class com.factual.driver.ReadResponse

G

getAddress() - Method in class com.factual.data_science_toolkit.Coord

getColumnSchema(String) - Method in class com.factual.driver.SchemaResponse

getColumnSchemas() - Method in class com.factual.driver.SchemaResponse

getConfidence() - Method in class com.factual.data_science_toolkit.Coord

getCountry() - Method in class com.factual.data_science_toolkit.Coord

getCrosswalks() - Method in class com.factual.driver.CrosswalkResponse

Returns the ordered collection of Crosswalks represented by this response.

getData() - Method in class com.factual.driver.ReadResponse

An ordered collection of the main data returned by Factual.

getData() - Method in class com.factual.driver.SchemaResponse

getData() - Method in interface com.factual.driver.Tabular

getDescription() - Method in class com.factual.driver.SchemaResponse

getFactualId() - Method in class com.factual.driver.Crosswalk

getIncludedRowCount() - Method in class com.factual.driver.Response

getJson() - Method in class com.factual.driver.CrosswalkResponse

getJson() - Method in class com.factual.driver.ReadResponse

getJson() - Method in class com.factual.driver.Response

Subclasses of Response must provide access to the original JSON representation of Factual's response.

getJson() - Method in class com.factual.driver.SchemaResponse

getLatitude() - Method in class com.factual.data_science_toolkit.Coord

getLocality() - Method in class com.factual.data_science_toolkit.Coord

getLongitude() - Method in class com.factual.data_science_toolkit.Coord

getNamespace() - Method in class com.factual.driver.Crosswalk

getNamespaceId() - Method in class com.factual.driver.Crosswalk

getRegion() - Method in class com.factual.data_science_toolkit.Coord

getRequestMethod() - Method in exception com.factual.driver.FactualApiException

getRequestUrl() - Method in exception com.factual.driver.FactualApiException

getResponse() - Method in exception com.factual.driver.FactualApiException

getSelectFields() - Method in class com.factual.driver.Query

getStatus() - Method in class com.factual.driver.Response

The status returned by the Factual API server, e.g.

getTitle() - Method in class com.factual.driver.SchemaResponse

getTotalRowCount() - Method in class com.factual.driver.Response

getUrl() - Method in class com.factual.driver.Crosswalk

getVersion() - Method in class com.factual.driver.Response

The version tag returned by the Factual API server, e.g.

greaterThan(Object) - Method in class com.factual.driver.QueryBuilder

greaterThanOrEqual(Object) - Method in class com.factual.driver.QueryBuilder

I

in(List<Object>) - Method in class com.factual.driver.QueryBuilder

in(Object...) - Method in class com.factual.driver.QueryBuilder

includeRowCount() - Method in class com.factual.driver.Query

The response will include a count of the total number of rows in the table that conform to the request based on included filters.

includeRowCount(boolean) - Method in class com.factual.driver.Query

When true, the response will include a count of the total number of rows in the table that conform to the request based on included filters.

isEmpty() - Method in class com.factual.driver.Response

isGeoEnabled() - Method in class com.factual.driver.SchemaResponse

isSearchEnabled() - Method in class com.factual.driver.SchemaResponse

J

JsonUtil - Class in com.factual.driver

JsonUtil() - Constructor for class com.factual.driver.JsonUtil

L

label - Variable in class com.factual.driver.ColumnSchema

lessThan(Object) - Method in class com.factual.driver.QueryBuilder

lessThanOrEqual(Object) - Method in class com.factual.driver.QueryBuilder

limit(int) - Method in class com.factual.driver.CrosswalkQuery

Adds the specified limit to this Query.

limit(long) - Method in class com.factual.driver.Query

Sets the maximum amount of records to return from this Query.

M

mapStrings(String) - Method in class com.factual.driver.ReadResponse

N

name - Variable in class com.factual.driver.ColumnSchema

namespace(String) - Method in class com.factual.driver.CrosswalkQuery

The namespace to search for a third party ID within.

namespaceId(String) - Method in class com.factual.driver.CrosswalkQuery

The id used by a third party to identify a place.

near(String, int) - Method in class com.factual.driver.Query

notBeginsWith(String) - Method in class com.factual.driver.QueryBuilder

notBeginsWithAny(Object...) - Method in class com.factual.driver.QueryBuilder

notBlank() - Method in class com.factual.driver.QueryBuilder

notEqual(Object) - Method in class com.factual.driver.QueryBuilder

notIn(List<Object>) - Method in class com.factual.driver.QueryBuilder

notIn(Object...) - Method in class com.factual.driver.QueryBuilder

O

offset(long) - Method in class com.factual.driver.Query

Sets how many records in to start getting results (i.e., the page offset) for this Query.

only(String...) - Method in class com.factual.driver.CrosswalkQuery

Restricts the results to only return ids for the specified namespace(s).

only(String...) - Method in class com.factual.driver.Query

Sets the fields to select.

op(String) - Method in class com.factual.driver.FilterGroup

Sets this FilterGroup's logic, e.g., "$or".

or(Query...) - Method in class com.factual.driver.Query

Used to nest OR'ed predicates.

Q

Query - Class in com.factual.driver

Represents a top level Factual query.

Query() - Constructor for class com.factual.driver.Query

QueryBuilder - Class in com.factual.driver

Provides fluent interface to specifying row filter predicate logic.

QueryBuilder(Query, String) - Constructor for class com.factual.driver.QueryBuilder

Constructor.

R

ReadResponse - Class in com.factual.driver

Represents the response from running a fetch request against Factual, such as a geolocation based query for specific places entities.

ReadResponse(String) - Constructor for class com.factual.driver.ReadResponse

Constructor, parses from a JSON response String.

requestMethod(String) - Method in exception com.factual.driver.FactualApiException

requestUrl(String) - Method in exception com.factual.driver.FactualApiException

resolve(ResolveQuery) - Method in class com.factual.driver.Factual

Asks Factual to resolve the Places entity for the attributes specified by query.

ResolveQuery - Class in com.factual.driver

ResolveQuery() - Constructor for class com.factual.driver.ResolveQuery

resolves(ResolveQuery) - Method in class com.factual.driver.Factual

Asks Factual to resolve the Places entity for the attributes specified by query.

response(HttpResponse) - Method in exception com.factual.driver.FactualApiException

Response - Class in com.factual.driver

Represents the basic concept of a response from Factual.

Response() - Constructor for class com.factual.driver.Response

S

schema(String) - Method in class com.factual.driver.Factual

SchemaResponse - Class in com.factual.driver

Represents the response from running a schema request against Factual.

SchemaResponse(String) - Constructor for class com.factual.driver.SchemaResponse

Constructor, parses from a JSON response String.

search(String) - Method in class com.factual.driver.Query

Sets a full text search query.

search(Object) - Method in class com.factual.driver.QueryBuilder

Specifies a full text search.

searchable - Variable in class com.factual.driver.ColumnSchema

setFactHome(String) - Method in class com.factual.driver.Factual

Change the base URL at which to contact Factual's API.

setFactualId(String) - Method in class com.factual.driver.Crosswalk

setNamespace(String) - Method in class com.factual.driver.Crosswalk

setNamespaceId(String) - Method in class com.factual.driver.Crosswalk

setUrl(String) - Method in class com.factual.driver.Crosswalk

size() - Method in class com.factual.driver.CrosswalkResponse

size() - Method in class com.factual.driver.ReadResponse

size() - Method in class com.factual.driver.SchemaResponse

sortable - Variable in class com.factual.driver.ColumnSchema

sortAsc(String) - Method in class com.factual.driver.Query

Sets this Query to sort field in ascending order.

sortDesc(String) - Method in class com.factual.driver.Query

Sets this Query to sort field in descending order.

streetToCoord(String) - Method in class com.factual.data_science_toolkit.DataScienceToolkit

Queries the Data Science Toolkit for the coordinates of a location specified with text.

T

Tabular - Interface in com.factual.driver

toJsonStr() - Method in class com.factual.driver.Circle

toJsonStr() - Method in class com.factual.driver.FieldFilter

Produces JSON representation of the represented filter logic.

toJsonStr() - Method in interface com.factual.driver.Filter

toJsonStr() - Method in class com.factual.driver.FilterGroup

Produces JSON representation for this FilterGroup

toString() - Method in class com.factual.data_science_toolkit.Coord

toString() - Method in class com.factual.driver.Crosswalk

toString() - Method in class com.factual.driver.Query

toString() - Method in class com.factual.driver.Response

toUrlQuery() - Method in class com.factual.driver.CrosswalkQuery

toUrlQuery() - Method in class com.factual.driver.Query

Builds and returns the query string to represent this Query when talking to Factual's API.

toUrlQuery() - Method in class com.factual.driver.ResolveQuery

U

UNDEFINED - Static variable in class com.factual.driver.Response

W

within(Circle) - Method in class com.factual.driver.Query

Adds a filter so that results can only be (roughly) within the specified geographic circle.

withMeta(Response, JSONObject) - Static method in class com.factual.driver.Response

Parses response metadata from rootJsonObj and adds it to response

A B C D E F G I J L M N O Q R S T U W