jadex.bridge.service.search.IKeyExtractor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jadex-platform-bridge Show documentation

Jadex bridge is a base package for kernels and platforms, i.e., it is used by both and provides commonly used interfaces and classes for active components and their management.

There is a newer version: 4.0.267

Show newest version

package jadex.bridge.service.search;

import java.util.Set;

/**
 *  Interface denoting key extraction functionality for indexers.
 */
public interface IKeyExtractor
{
	/** Match any value constant for values. Indexer checks if value is ANY and then it always matches.*/
	public static String MATCH_ALWAYS = "always";
	
	/**
	 *  Extracts key value from an object.
	 *  
	 *  @param keytype The type of key being extracted.
	 *  @param value The value.
	 *  @return The keys matching the type.
	 */
	public Set getKeyValues(String keytype, T value);
	
	/**
	 *  Extracts the matching mode from a multivalued term.
	 *  true = AND, false = OR
	 *  
	 *  @param keytype The type of key being extracted.
	 *  @param value The value.
	 *  @return The key matching mode.
	 */
	public Boolean getKeyMatchingMode(String keytype, T value);
	
	/**
	 *  Get the key names for this type of extractor.
	 *  @return The key names.
	 */
	public String[] getKeyNames();
}