opendial.templates

Interface Template

All Superinterfaces:

java.lang.Comparable<Template>

All Known Implementing Classes:

FunctionalTemplate, RelationalTemplate, StringTemplate

public interface Template
extends java.lang.Comparable<Template>

Representation of a (possibly underspecified) template for a Value. An example of template is "Foobar({X},{Y})", where {X} and {Y} are underspecified slots that can take any value. One can also use template to encode simple regular expressions such as "the (big)? (box|cylinder)", which can match strings such as "the box" or "the big cylinder".

Template objects supports 3 core operations:

• match(string): full match of the template against the string. If the template contains slots, returns their values resulting from the match.
• find(string): find all possible occurrences of the template in the string.
• fillSlots(assignment): returns the string resulting from the replacement of the slot values by their values in the assignment.

Different implements of the template interface are provided, to allow for "full string" templates (without any underspecification), templates based on regular expressions, mathematical expressions, and templates operating on semantic graphs.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Template.MatchResult Representation of a matching result

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.logging.Logger	log

Method Summary

Modifier and Type	Method and Description
default int	compareTo(Template other) Compares the templates (based on their string value)
static Template	create(java.lang.String value) Creates a new template based on the string value.
java.lang.String	fillSlots(Assignment fillers) Fills the template with the given content, and returns the filled string.
java.util.List<Template.MatchResult>	find(java.lang.String str, int maxResults) Searches for all occurrences of the template in the str.
java.util.Set<java.lang.String>	getSlots() Returns the (possibly empty) set of slots for the template
boolean	isFilledBy(Assignment input) Returns true if the provided variables cover all of the slots in the template.
boolean	isUnderspecified() Returns true if the template is an actual template, i.e. can match multiple values (due to slots or alternative/optional elements)
Template.MatchResult	match(java.lang.String str) Checks whether the string is matching the template or not.
default Template.MatchResult	partialmatch(java.lang.String str) Checks whether the template can be found within the string.

Field Detail

log

static final java.util.logging.Logger log

Method Detail

create

static Template create(java.lang.String value)

Creates a new template based on the string value. This method finds the best template representation for the string and returns the result.

Parameters:

value - the string for the template

Returns:

the corresponding template object

getSlots

java.util.Set<java.lang.String> getSlots()

Returns the (possibly empty) set of slots for the template

Returns:

the set of slots

isUnderspecified

boolean isUnderspecified()

Returns true if the template is an actual template, i.e. can match multiple values (due to slots or alternative/optional elements)

Returns:

true if underspecified, false otherwise

match

Template.MatchResult match(java.lang.String str)

Checks whether the string is matching the template or not. The matching result contains a boolean representing the outcome of the process, as well (if the match is successful) as the boundaries of the match and the extracted slot values.

Parameters:

str - the string to check

Returns:

the matching result

partialmatch

default Template.MatchResult partialmatch(java.lang.String str)

Checks whether the template can be found within the string. The matching result contains a boolean representing the outcome of the process, as well (if the match is successful) as the boundaries of the match and the extracted slot values.

Parameters:

str - the string to check

Returns:

the matching result

find

java.util.List<Template.MatchResult> find(java.lang.String str,
                                          int maxResults)

Searches for all occurrences of the template in the str. The maximum number of occurrences to find is specified in maxResults.

Parameters:

str - the string to check

maxResults - the maximum number of occurrences

Returns:

the matching results

isFilledBy

boolean isFilledBy(Assignment input)

Returns true if the provided variables cover all of the slots in the template. Otherwise, returns false.

Parameters:

input - the input

Returns:

true if all slots can be filled, and false otherwise.

fillSlots

java.lang.String fillSlots(Assignment fillers)

Fills the template with the given content, and returns the filled string. The content provided in the form of a slot:filler mapping. For instance, given a template: "my name is {name}" and a filler "name:Pierre", the method will return "my name is Pierre".

Parameters:

fillers - the content associated with each slot.

Returns:

the string filled with the given content

compareTo

default int compareTo(Template other)

Compares the templates (based on their string value)

Specified by:

compareTo in interface java.lang.Comparable<Template>

Parameters:

other - the second template

Returns:

the comparison result