Package org.apache.nlpcraft.model

Interface NCVariant

All Superinterfaces:

Collection<NCToken>, Iterable<NCToken>, List<NCToken>, NCMetadata

public interface NCVariant
extends List<NCToken>, NCMetadata

A parsing variant is a list of tokens representing one possible parsing variant of the user input.

Note that a given user input can have one or more possible different parsing variants. Depending on model configuration a user input can produce hundreds or even thousands of parsing variants.

See Also:

NCModel.onParsedVariant(NCVariant), NCContext.getVariants()

Method Summary

Modifier and Type	Method	Description
default List<NCToken>	getAbstractTokens()	Utility method that returns all abstract tokens.
default List<NCToken>	getFreeTokens()	Utility method that returns all freeword tokens.
default List<NCToken>	getMatchedTokens()	Utility method that returns all non-freeword tokens.
default List<NCToken>	getStopWordTokens()	Utility method that returns all stop word tokens.
default List<NCToken>	getUserDefinedTokens()	Utility method that returns all user-defined tokens.

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Methods inherited from interface org.apache.nlpcraft.model.NCMetadata

getMetadata, meta, meta, metaOpt, metax

Method Detail

getMatchedTokens

default List<NCToken> getMatchedTokens()

Utility method that returns all non-freeword tokens. It's equivalent to:

     return stream().filter(tok -> !tok.isFreeWord() && !tok.isStopWord()).collect(Collectors.toList());
 

Returns:

All non-freeword tokens.

See Also:

NCToken.isFreeWord()

getFreeTokens

default List<NCToken> getFreeTokens()

Utility method that returns all freeword tokens. It's equivalent to:

     return stream().filter(NCToken::isFreeWord).collect(Collectors.toList());
 

Returns:

All freeword tokens.

See Also:

NCToken.isFreeWord()

getAbstractTokens

default List<NCToken> getAbstractTokens()

Utility method that returns all abstract tokens. It's equivalent to:

     return stream().filter(NCToken::isAbstract).collect(Collectors.toList());
 

Returns:

All abstract tokens.

See Also:

NCToken.isAbstract()

getStopWordTokens

default List<NCToken> getStopWordTokens()

Utility method that returns all stop word tokens. It's equivalent to:

     return stream().filter(NCToken::isStopWord).collect(Collectors.toList());
 

Returns:

All stop word tokens.

See Also:

NCToken.isAbstract()

getUserDefinedTokens

default List<NCToken> getUserDefinedTokens()

Utility method that returns all user-defined tokens. It's equivalent to:

     return stream().filter(NCToken::isUserDefined).collect(Collectors.toList());
 

Returns:

All user-defined tokens.

See Also:

NCToken.isUserDefined()