Package com.tibco.ep.tcs.runtime.config

Class SearchMetaDataConfig

java.lang.Object

com.tibco.ep.tcs.runtime.config.BaseConfig

com.tibco.ep.tcs.runtime.config.SearchMetaDataConfig

public final class SearchMetaDataConfig
extends BaseConfig

A class containing search metadata for a flow or block.

Constructor Summary

Constructors

Constructor	Description
SearchMetaDataConfig()	Create a new empty search metadata configuration.
SearchMetaDataConfig(ISearchMetaData source)	Create a new search metadata object from the specified interface source.
SearchMetaDataConfig(com.typesafe.config.Config config)	Create a new search metadata instance from HOCON configuration.

Method Summary

Modifier and Type	Method	Description
SearchMetaDataConfig	addKeyword(String keyword)	Add a keyword.
SearchMetaDataConfig	addSecondaryCategory(String secondaryCategory)	Add a secondary category.
protected void	fillMap(Map<String,Object> props)	Add this object's properties to the specified map.
List<String>	getKeywords()	Return the search object's set of search keywords, null if none.
String	getPrimaryCategory()	Return the search object's primary category, null if none.
List<String>	getSecondaryCategories()	Return the search object's secondary categories, null if none.
SearchMetaDataConfig	setKeywords(List<String> keywords)	Set the search object's set of search keywords, null if none.
SearchMetaDataConfig	setPrimaryCategory(String primaryCategory)	Set the search object's primary category, null if none.
SearchMetaDataConfig	setSecondaryCategories(List<String> secondaryCategories)	Set the search object' secondary categories, null if none.

Methods inherited from class com.tibco.ep.tcs.runtime.config.BaseConfig

toHOCON

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchMetaDataConfig

public SearchMetaDataConfig()

Create a new empty search metadata configuration.

SearchMetaDataConfig

public SearchMetaDataConfig(ISearchMetaData source)

Create a new search metadata object from the specified interface source.

Parameters:

source - source object

SearchMetaDataConfig

public SearchMetaDataConfig(com.typesafe.config.Config config)

Create a new search metadata instance from HOCON configuration.

Parameters:

config - HOCON representation of the metadata

Method Detail

getPrimaryCategory

public String getPrimaryCategory()

Return the search object's primary category, null if none. Free-form.

Returns:

primary category, null if none

setPrimaryCategory

public SearchMetaDataConfig setPrimaryCategory(String primaryCategory)

Set the search object's primary category, null if none. Free-form.

Parameters:

primaryCategory - primary category, null if none

Returns:

this object

getSecondaryCategories

public List<String> getSecondaryCategories()

Return the search object's secondary categories, null if none. Free-form.

Returns:

secondary categories, null if none

setSecondaryCategories

public SearchMetaDataConfig setSecondaryCategories(List<String> secondaryCategories)

Set the search object' secondary categories, null if none. Free-form.

Parameters:

secondaryCategories - secondary categories, null if none

Returns:

this object

addSecondaryCategory

public SearchMetaDataConfig addSecondaryCategory(String secondaryCategory)

Add a secondary category. Free-form. Cannot be null.

Parameters:

secondaryCategory - secondary category

Returns:

this object

getKeywords

public List<String> getKeywords()

Return the search object's set of search keywords, null if none. Free-form.

Returns:

keywords, null if none

setKeywords

public SearchMetaDataConfig setKeywords(List<String> keywords)

Set the search object's set of search keywords, null if none. Free-form.

Parameters:

keywords - keywords, null if none

Returns:

this object

addKeyword

public SearchMetaDataConfig addKeyword(String keyword)

Add a keyword. Free-form. Cannot be null.

Parameters:

keyword - keyword

Returns:

this object

fillMap

protected void fillMap(Map<String,Object> props)

Add this object's properties to the specified map.

Specified by:

fillMap in class BaseConfig

Parameters:

props - map to fill