com.atlassian.jira.upgrade.tasks.jql
Interface ClauseXmlHandler

All Known Implementing Classes:

AbsoluteDateXmlHandler, AbstractCustomFieldClauseXmlHandler, AbstractSimpleClauseXmlHandler, AffectedVersionClauseXmlHandler, CascadeSelectParameterClauseXmlHandler, ComponentClauseXmlHandler, ConstantsClauseXmlHandler, FixForVersionClauseXmlHandler, JqlClauseXmlHandler, MultiValueParameterClauseXmlHandler, ProjectClauseXmlHandler, RelativeDateXmlHandler, SimpleCustomFieldClauseXmlHandler, StringRangeParameterClauseXmlHandler, TextSystemFieldClauseXmlHandler, UserClauseXmlHandler, UserGroupParameterCustomFieldClauseXmlHandler, UserParameterCustomFieldClauseXmlHandler, WorkRatioClauseXmlHandler

public interface ClauseXmlHandler

This is here so that Terminal XML nodes can be produced from XML fragments so that we can incrementally transition from SearchParameters to JiraQuery based searches. This will allow a JiraQuery terminal node to be able to participate in persisting a search request via the OLD XML method. NOTE: eventually when all SearchParameters have been destroyed we should just save the JQL and this will only be used in an upgrade task.

Since:

v4.0

See Also:

UpgradeTask_Build604

Nested Class Summary

static class	ClauseXmlHandler.BestGuessConversionResult
static interface	ClauseXmlHandler.ConversionResult
static class	ClauseXmlHandler.ConversionResultType
static class	ClauseXmlHandler.FailedConversionNoValuesResult
static class	ClauseXmlHandler.FailedConversionResult
static class	ClauseXmlHandler.FullConversionResult
static class	ClauseXmlHandler.NoOpConversionResult A way for a handler to "opt-out" of doing any conversion.

Method Summary

ClauseXmlHandler.ConversionResult	convertXmlToClause(electric.xml.Element el) Produce a clause from the legacy, SearchParameter, XML storage format.
boolean	isSafeToNamifyValue() Some search parameters have values which when running through "namification" could lose precision or change the original meaning of the value.

Method Detail

convertXmlToClause

ClauseXmlHandler.ConversionResult convertXmlToClause(electric.xml.Element el)

Produce a clause from the legacy, SearchParameter, XML storage format.

Parameters:

el - XML element

Returns:

a Clause that corresponds to the search that is described by the XML, must not be null.

isSafeToNamifyValue

boolean isSafeToNamifyValue()

Some search parameters have values which when running through "namification" could lose precision or change the original meaning of the value. This flag indicates whether it is safe for the upgrade task to namify the values.

Returns:

true if is safe to namify values produced by this handler; false otherwise.