com.ibm.watson.developer_cloud.discovery.v1.model

Class QueryRelations

java.lang.Object

com.ibm.watson.developer_cloud.service.model.GenericModel

com.ibm.watson.developer_cloud.discovery.v1.model.QueryRelations

All Implemented Interfaces:

ObjectModel

public class QueryRelations
extends GenericModel

A JSON respresentation of a relationship query.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	QueryRelations.Sort The sorting method for the relationships, can be `score` or `frequency`.

Constructor Summary

Constructors

Constructor and Description
QueryRelations()

Method Summary

Methods

Modifier and Type	Method and Description
QueryEntitiesContext	getContext() Gets the context.
java.lang.Long	getCount() Gets the count.
java.util.List<QueryRelationsEntity>	getEntities() Gets the entities.
QueryRelationsFilter	getFilter() Gets the filter.
java.lang.String	getSort() Gets the sort.
void	setContext(QueryEntitiesContext context) Sets the context.
void	setCount(long count) Sets the count.
void	setEntities(java.util.List<QueryRelationsEntity> entities) Sets the entities.
void	setFilter(QueryRelationsFilter filter) Sets the filter.
void	setSort(java.lang.String sort) Sets the sort.

Methods inherited from class com.ibm.watson.developer_cloud.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

QueryRelations

public QueryRelations()

Method Detail

getEntities

public java.util.List<QueryRelationsEntity> getEntities()

Gets the entities. An array of entities to find relationships for.

Returns:

the entities

getContext

public QueryEntitiesContext getContext()

Gets the context. Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted to query the city of London in England your query would look for `London` with the context of `England`.

Returns:

the context

getSort

public java.lang.String getSort()

Gets the sort. The sorting method for the relationships, can be `score` or `frequency`. `frequency` is the number of unique times each entity is identified. The default is `score`

Returns:

the sort

getFilter

public QueryRelationsFilter getFilter()

Gets the filter. Filters to apply to the relationship query

Returns:

the filter

getCount

public java.lang.Long getCount()

Gets the count. The number of results to return. The default is `10`. The maximum is `1000`.

Returns:

the count

setEntities

public void setEntities(java.util.List<QueryRelationsEntity> entities)

Sets the entities.

Parameters:

entities - the new entities

setContext

public void setContext(QueryEntitiesContext context)

Sets the context.

Parameters:

context - the new context

setSort

public void setSort(java.lang.String sort)

Sets the sort.

Parameters:

sort - the new sort

setFilter

public void setFilter(QueryRelationsFilter filter)

Sets the filter.

Parameters:

filter - the new filter

setCount

public void setCount(long count)

Sets the count.

Parameters:

count - the new count