org.teiid.connector.metadata
Class MetadataLiteralCriteria

java.lang.Object
  org.teiid.connector.metadata.MetadataLiteralCriteria

All Implemented Interfaces:

MetadataSearchCriteria

public class MetadataLiteralCriteria
extends java.lang.Object
implements MetadataSearchCriteria

This object is used for construting match patterns used to query index files containing metadata information. This object can also be used to post process results after querying index files. This object directly mapps to a single criteria in a SQL query.

Since:

4.3

Constructor Summary

MetadataLiteralCriteria(java.lang.String fieldName, java.lang.Object fieldValue)
Constructor MetadataLiteralCriteria

Method Summary

java.lang.Object	getEvaluatedValue() Get the value of the literal field used in the criteria with any function on it evaluated.
java.lang.String	getFieldFunction() Get the name of the function applied on the field part of criteria.
java.lang.String	getFieldName() Get the name of field used on criteria which gets matched against a literal.
java.lang.Object	getFieldValue() Get the value of field used on criteria which is a literal used as part of seach criteria.
java.lang.String	getValueFunction() Get the name of the function applied on the literal part of criteria.
boolean	hasFieldWithCaseFunctions() Return true if any case functions are involved on the fieldName of this criteria
boolean	isFalseCriteria() Check if this criteria evaluates to a false criteria.
void	setFieldFunction(java.lang.String fieldFunction) Set the name of the function applied on the field part of criteria.
void	setValueFunction(java.lang.String valueFunction) Set the name of the function applied on the literal part of criteria.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataLiteralCriteria

public MetadataLiteralCriteria(java.lang.String fieldName,
                               java.lang.Object fieldValue)

Constructor MetadataLiteralCriteria

Parameters:

fieldName - The name of field used on criteria which gets matched against a literal.

fieldValue - The value of field used on criteria which is a literal used as part of seach criteria.

Since:

4.3

Method Detail

getFieldFunction

public java.lang.String getFieldFunction()

Get the name of the function applied on the field part of criteria.

Returns:

returns the fieldFunction.

Since:

4.3

setFieldFunction

public void setFieldFunction(java.lang.String fieldFunction)

Set the name of the function applied on the field part of criteria.

Parameters:

fieldFunction - The fieldFunction to set.

Since:

4.3

getFieldName

public java.lang.String getFieldName()

Get the name of field used on criteria which gets matched against a literal.

Returns:

returns the fieldName.

Since:

4.3

getFieldValue

public java.lang.Object getFieldValue()

Get the value of field used on criteria which is a literal used as part of seach criteria.

Returns:

returns the fieldValue.

Since:

4.3

isFalseCriteria

public boolean isFalseCriteria()

Check if this criteria evaluates to a false criteria.

Returns:

true if this evaluates to a false criteria else false

Since:

4.3

getEvaluatedValue

public java.lang.Object getEvaluatedValue()

Get the value of the literal field used in the criteria with any function on it evaluated.

Returns:

returns the fieldValue.

Since:

4.3

getValueFunction

public java.lang.String getValueFunction()

Get the name of the function applied on the literal part of criteria.

Returns:

returns the valueFunction.

Since:

4.3

setValueFunction

public void setValueFunction(java.lang.String valueFunction)

Set the name of the function applied on the literal part of criteria.

Parameters:

valueFunction - The valueFunction to set.

Since:

4.3

hasFieldWithCaseFunctions

public boolean hasFieldWithCaseFunctions()

Return true if any case functions are involved on the fieldName of this criteria

Returns:

true if there are any functions else false.

Since:

4.3