com.languagecomputer.api.query
Interface Query

All Known Implementing Classes:

DefaultQuery, MergedQuery

public interface Query

Structure for a user query. Allows various systems to specify different representations of queries such as:

• natural language
• keyword
• required entity types
• structured data

Since:

1.0

Author:

Kirk Roberts

Method Summary

Set<Keyword>	getKeywords() Returns the keywords for this Query.
String	getNaturalLanguage() Returns the natural language representation for this Query.
Set<String>	getRequiredEntityTypes() Returns the required entity types for this Query.
String	getStructuredQuery() Returns the structured data query for this Query.

Method Detail

getNaturalLanguage

String getNaturalLanguage()

Returns the natural language representation for this Query. This could be a question, a command, or just traditional keywords.

Returns:

A String representation of this Query, or null if it has no natural language representation.

getKeywords

Set<Keyword> getKeywords()

Returns the keywords for this Query.

Returns:

A Set of Keywords representing this Query, or null if it has no keyword representation.

getRequiredEntityTypes

Set<String> getRequiredEntityTypes()

Returns the required entity types for this Query.

Returns:

A Set of mandatory entity types representing this Query, or null if it has no required entity types representation.

getStructuredQuery

String getStructuredQuery()

Returns the structured data query for this Query.

Returns:

A String-based structured query representing this Query, or null if it has no structured query representation.