com.groupbyinc.api.model

Class Record

java.lang.Object

com.groupbyinc.api.model.Record

public class Record
extends java.lang.Object

A Record represents a result from the search engine. Each record has all the requested metadata as specified in fields parameter. Each record also has several special fields. - `id`: an MD5 hash of the unique URL of this record. - `url`: the unique url of the record. - `snippet`: If there is a keyword match, the snippet of text. Matches have <b> tags surrounding them. - `title`: The title of the record. - `allMeta`: a map of key value pairs. If a value is multi-assign, there will additionally be a <key>List item, with all the values.

Author:

will

Constructor Summary

Constructors

Constructor and Description
Record()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getAllMeta()
java.lang.String	getId()
java.lang.Object	getMetaValue(java.lang.String name)
java.util.List<RefinementMatch>	getRefinementMatches()
java.lang.String	getSnippet()
java.lang.String	getTitle() The title of this record
java.lang.String	getUrl() This URL is generated by the data upload service and follows the format http://1.com/.html
Record	setAllMeta(java.util.Map<java.lang.String,java.lang.Object> allMeta)
Record	setId(java.lang.String id)
Record	setRefinementMatches(java.util.List<RefinementMatch> refinementMatches)
Record	setSnippet(java.lang.String snippet)
Record	setTitle(java.lang.String title)
Record	setUrl(java.lang.String url)

Methods inherited from class java.lang.Object

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

Constructor Detail

Record

public Record()

Method Detail

getRefinementMatches

public java.util.List<RefinementMatch> getRefinementMatches()

Returns:

setRefinementMatches

public Record setRefinementMatches(java.util.List<RefinementMatch> refinementMatches)

Parameters:

refinementMatches - The list of refinement matches

Returns:

getId

public java.lang.String getId()

Returns:

The ID is generated from URL of this record which means it will persist across updates.

setId

public Record setId(java.lang.String id)

Parameters:

id - Set the id

Returns:

getUrl

public java.lang.String getUrl()

This URL is generated by the data upload service and follows the format http://1.com/.html

Returns:

The URL represents the Unique ID of the record.

setUrl

public Record setUrl(java.lang.String url)

Parameters:

url - Set the record url

Returns:

getSnippet

public java.lang.String getSnippet()

Returns:

If a search was performed this result object may have a snippet of matching text.

setSnippet

public Record setSnippet(java.lang.String snippet)

Parameters:

snippet - Set the snippet

Returns:

getMetaValue

public java.lang.Object getMetaValue(java.lang.String name)

Parameters:

name - Get a specific metadata value. Essentially this represents an attribute of the record data.

Returns:

getAllMeta

public java.util.Map<java.lang.String,java.lang.Object> getAllMeta()

Returns:

A map of all the metadata associated with this record.

setAllMeta

public Record setAllMeta(java.util.Map<java.lang.String,java.lang.Object> allMeta)

Parameters:

allMeta - Set the metadata.

Returns:

getTitle

public java.lang.String getTitle()

The title of this record

Returns:

The title of this record.

setTitle

public Record setTitle(java.lang.String title)

Parameters:

title - Set the title