About

This repository contains a simple client library that can be used to query the Yahoo Query Language (YQL) web service.

For more information on YQL, please refer to: https://developer.yahoo.com/yql/

Usage Example

YqlClient client = YqlClients.createDefault();
YqlQuery query = YqlQueryBuilder
				.fromQueryString("select * from geo.oceans where name=@name")
				.withVariable("name", "Arctic Ocean").build();
YqlResult result = client.query(query);

// Now you can do whatever you like with the raw result
String rawResult = result.getContentAsString();

// But if you are lazy, you may also get the content mapped as object graph
// Please note though: You will have to provide your own mapping classes, 
// i.e. PlaceArrayType and PlaceType!
QueryResultType<PlaceArrayType> mappedResult = 
		result.getContentAsMappedObject(
				new TypeReference<QueryResultType<PlaceArrayType>>() {});
for (PlaceType item : mappedResult.getResults().getPlace()) {
	// Do something with the item
}

Features

• YqlQuery takes care of building the request URL for you
  • Built-in parameters diagnostics, env etc. are supported
  • Support for YQL variable substitution
  • Support for YQL query aliases
• YqlResult supports mapping the content to an object graph
• Support OAuth signed requests (may or may not be useful)

What's missing

• Streaming support
• OAuth authentication (two-legged and three-legged)

Download

The recommended way to get started using YQL4J in your project is by using the following Maven coordinates:

<dependency>
    <groupId>org.yql4j</groupId>
    <artifactId>yql4j-client</artifactId>
    <version>0.9.4</version>
</dependency>