Class SearchTemplateKey
java.lang.Object
com.orchestranetworks.search.template.SearchTemplateKey
Identifies a search template.
- Since:
- 6.0.0
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionboolean
format()
Returns a persistent identifier for this service key.static SearchTemplateKey
forModuleSearchTemplateName
(String aModuleName, String aSearchTemplateName) getName()
Returns the full name of the search template.Returns the local name of the search template by removing the prefix and including the '@' character.int
hashCode()
boolean
Returnstrue
if this instance identifies a built-in template.static SearchTemplateKey
Returns the template key that corresponds to the specified string.toString()
-
Method Details
-
parse
Returns the template key that corresponds to the specified string.The specified string is generally generated by the method
format()
.- Throws:
IllegalArgumentException
- if the specified string does not match the regular expression([-\\d\\pL:_.]*)@?(%?[-\\d\\pL:_. /]+)
.
-
forModuleSearchTemplateName
public static SearchTemplateKey forModuleSearchTemplateName(String aModuleName, String aSearchTemplateName) -
getModuleName
-
getSearchTemplateName
Returns the local name of the search template by removing the prefix and including the '@' character. -
getName
Returns the full name of the search template. -
isBuiltInTemplate
public boolean isBuiltInTemplate()Returnstrue
if this instance identifies a built-in template. -
format
Returns a persistent identifier for this service key.The search template key can be re-obtained by parsing this persistent identifier using the method
parse(String)
. -
hashCode
public int hashCode() -
equals
-
toString
-