Package org.opencms.ui.apps.search
Class CmsSearchReplaceSettings
java.lang.Object
org.opencms.ui.apps.search.CmsSearchReplaceSettings
- All Implemented Interfaces:
Serializable
Settings bean for the dialog.
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionBean constructor with cms object for path validation. -
Method Summary
Modifier and TypeMethodDescriptionGet element to search for.Returns the locale.getPaths()Get property.getQuery()Returns the query.String[]Returns the resources paths in an array.Returns the site root.Returns the source.getType()Returns the search type.getTypes()Returns the resource type(s).String[]Returns the type.getXpath()Returns the xpath.booleanShould subsites be ignored?booleanReturns the force replace flag, iftruethe replacement will also be performed if the replacement String is empty.booleanReturns if only content values should be searched and replaced.booleanReturnstrueif Solr index is selected and a query was entered.static StringreplaceElementInPagePattern(CmsResource resource) Replace element pattern.static StringsearchElementInPagePattern(CmsResource resource) Search element in xml page pattern.voidsetElementResource(CmsResource resource) Set Element to search for.voidsetForceReplace(boolean forceReplace) Sets the force replace flag.voidsetIgnoreSubSites(boolean ignore) Set if subsites should be ignored.voidSets the locale.voidsetMessage(String message) voidsetOnlyContentValues(boolean onlyContentValue) Sets if only content values should be searched and replaced.voidSets the paths.voidsetProject(String project) voidsetProperty(CmsPropertyDefinition value) Sets the property.voidSets the query.voidsetReplacepattern(String replacepattern) Sets the replace pattern.voidsetResources(String resources) voidsetSearchpattern(String searchpattern) Sets the search pattern.voidsetSiteRoot(String siteRoot) Sets the site root.voidSets the source.voidSets the search type.voidSets the resource type(s).voidSets the xpath.
-
Constructor Details
-
CmsSearchReplaceSettings
public CmsSearchReplaceSettings()Bean constructor with cms object for path validation.
-
-
Method Details
-
replaceElementInPagePattern
Replace element pattern.- Parameters:
resource- Resource to replace- Returns:
- String regex
-
searchElementInPagePattern
Search element in xml page pattern.- Parameters:
resource- Resource- Returns:
- String regex
-
getElementResource
Get element to search for.- Returns:
- CmsResource
-
getLocale
Returns the locale.- Returns:
- the locale
-
getMessage
- Returns:
- the message
-
getPaths
- Returns:
- the paths
-
getProject
- Returns:
- the project
-
getProperty
Get property.- Returns:
- CmsPropertyDefinition
-
getQuery
Returns the query.- Returns:
- the query
-
getReplacepattern
- Returns:
- the replace pattern
-
getResources
- Returns:
- the resources
-
getResourcesArray
Returns the resources paths in an array.- Returns:
- the resources paths in an array.
-
getSearchpattern
- Returns:
- the search pattern
-
getSiteRoot
Returns the site root.- Returns:
- the siteRoot
-
getSource
Returns the source.- Returns:
- the source
-
getType
Returns the search type.- Returns:
- the search type
-
getTypes
Returns the resource type(s).- Returns:
- the type
-
getTypesArray
Returns the type.- Returns:
- the type
-
getXpath
Returns the xpath.- Returns:
- the xpath
-
ignoreSubSites
Should subsites be ignored?- Returns:
- boolean
-
isForceReplace
Returns the force replace flag, iftruethe replacement will also be performed if the replacement String is empty.- Returns:
- the force replace flag
-
isOnlyContentValues
Returns if only content values should be searched and replaced.- Returns:
- if only content values should be searched and replaced
-
isSolrSearch
Returnstrueif Solr index is selected and a query was entered.- Returns:
trueif Solr index is selected and a query was entered
-
setElementResource
Set Element to search for.- Parameters:
resource- CmsResource
-
setForceReplace
Sets the force replace flag.- Parameters:
forceReplace- the force replace flag to set
-
setIgnoreSubSites
Set if subsites should be ignored.- Parameters:
ignore- boolean
-
setLocale
Sets the locale.- Parameters:
locale- the locale to set
-
setMessage
- Parameters:
message- the message to set
-
setOnlyContentValues
Sets if only content values should be searched and replaced.- Parameters:
onlyContentValue- if only content values should be searched and replaced
-
setPaths
Sets the paths.- Parameters:
paths- the paths to set
-
setProject
- Parameters:
project- the project to work in
-
setProperty
Sets the property.- Parameters:
value- CmsPropertyDefinition
-
setQuery
Sets the query.- Parameters:
query- the query to set
-
setReplacepattern
Sets the replace pattern.- Parameters:
replacepattern- the replace pattern
-
setResources
- Parameters:
resources- the resources to set
-
setSearchpattern
Sets the search pattern.- Parameters:
searchpattern- the search pattern
-
setSiteRoot
Sets the site root.- Parameters:
siteRoot- the site root to set
-
setSource
Sets the source.- Parameters:
source- the source to set
-
setType
Sets the search type.- Parameters:
type- the search type to set
-
setTypes
Sets the resource type(s).- Parameters:
types- the type to set
-
setXpath
Sets the xpath.- Parameters:
xpath- the xpath to set
-