|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.jira.issue.fields.CustomFieldImpl
public class CustomFieldImpl
Default CustomField implementation backed by the database (a GenericValue object).
Usually managed via CustomFieldManager
.
store()
after calling any setter methods.
Nested Class Summary | |
---|---|
(package private) static class |
CustomFieldImpl.CustomFieldIssueSortComparator
|
Field Summary | |
---|---|
static String |
ENTITY_CF_TYPE_KEY
|
static String |
ENTITY_CUSTOM_FIELD_SEARCHER
|
static String |
ENTITY_DESCRIPTION
|
static String |
ENTITY_ID
|
static String |
ENTITY_ISSUETYPE
|
static String |
ENTITY_NAME
|
static String |
ENTITY_PROJECT
|
static String |
ENTITY_TABLE_NAME
|
Fields inherited from interface com.atlassian.jira.issue.fields.NavigableField |
---|
ORDER_ASCENDING, ORDER_DESCENDING, TEMPLATE_DIRECTORY_PATH |
Fields inherited from interface com.atlassian.jira.issue.fields.OrderableField |
---|
MOVE_ISSUE_PARAM_KEY, NO_HEADER_PARAM_KEY |
Constructor Summary | |
---|---|
CustomFieldImpl(org.ofbiz.core.entity.GenericValue customField,
CustomFieldManager customFieldManager,
JiraAuthenticationContext authenticationContext,
ConstantsManager constantsManager,
FieldConfigSchemeManager fieldConfigSchemeManager,
PermissionManager permissionManager,
RendererManager rendererManager)
|
Method Summary | |
---|---|
protected static boolean |
areDifferent(Object obj1,
Object obj2)
Compare two objects - return false if both are null or equal. |
String |
availableForBulkEdit(BulkEditBean bulkEditBean)
Checks if custom field is available for bulk edit operation, whether 'shown' and if user has bulk update permission. |
int |
compare(Issue issue1,
Issue issue2)
This method compares the values of this custom field in two given issues. |
int |
compareTo(Object o)
|
void |
createValue(Issue issue,
Object value)
Create the value of the issue in the data store. |
boolean |
equals(Object o)
|
List |
getAssociatedIssueTypes()
Returns a list of issue types associated with this project. |
List |
getAssociatedProjectCategories()
Returns a list of associated project categories for this custom field. |
List |
getAssociatedProjects()
Returns a list of projects associated with this project. |
List |
getAssociatedSearchers()
Returns a list of searchers associated with field |
String |
getBulkEditHtml(OperationContext operationContext,
webwork.action.Action action,
BulkEditBean bulkEditBean,
Map displayParameters)
Returns HTML that should be shown when the issue is being bulk edited. |
String |
getColumnCssClass()
|
String |
getColumnHeadingKey()
|
String |
getColumnViewHtml(FieldLayoutItem fieldLayoutItem,
Map displayParams,
Issue issue)
|
List |
getConfigurationItemTypes()
Returns a List of FieldConfigItemType objects. |
List |
getConfigurationSchemes()
Returns a list of configuration schemes. |
String |
getCreateHtml(FieldLayoutItem fieldLayoutItem,
OperationContext operationContext,
webwork.action.Action action,
Issue issue)
Returns the HTML that should be shown when the issue is being created |
String |
getCreateHtml(FieldLayoutItem fieldLayoutItem,
OperationContext operationContext,
webwork.action.Action action,
Issue issue,
Map dispayParameters)
Returns the HTML that should be shown when the issue is being created |
CustomFieldSearcher |
getCustomFieldSearcher()
Retrieves the CustomFieldSearcher for this custom field looking it up in the customFieldManager
by the searcher key retrieved from ENTITY_CUSTOM_FIELD_SEARCHER underlying generic value attribute. |
CustomFieldType |
getCustomFieldType()
Looks up the CustomFieldType in the customFieldManager by
the key retrieved from the ENTITY_CF_TYPE_KEY attribute of the underlying generic value. |
CustomFieldParams |
getCustomFieldValues(Map customFieldValuesHolder)
Get the custom field string values that are relevant to this particular custom field |
String |
getDefaultSortOrder()
Returns NavigableField.ORDER_ASCENDING . |
Object |
getDefaultValue(Issue issue)
The value that should be set on the issue if the field is not shown for some reason. |
String |
getDescription()
Returns the description of this custom field by reading ENTITY_DESCRIPTION of the underlying generic value. |
String |
getEditHtml(FieldLayoutItem fieldLayoutItem,
OperationContext operationContext,
webwork.action.Action action,
Issue issue)
Returns HTML that should be shown when the issue is being edited |
String |
getEditHtml(FieldLayoutItem fieldLayoutItem,
OperationContext operationContext,
webwork.action.Action action,
Issue issue,
Map dispayParameters)
Returns HTML that should be shown when the issue is being edited |
FieldConfig |
getFirstRelevantConfig(org.ofbiz.core.entity.GenericValue project,
List issueTypeIds)
Deprecated. |
org.ofbiz.core.entity.GenericValue |
getGenericValue()
Deprecated. |
String |
getHiddenFieldId()
Returns the id of the field to check for visibility. |
protected I18nHelper |
getI18nHelper()
|
String |
getId()
The unique id of the field |
Long |
getIdAsLong()
Returns ID of this custom field. |
String |
getName()
Returns the name of this custom field by reading ENTITY_NAME of the underlying generic value. |
String |
getNameKey()
The i18n key that is used to lookup the field's name when it is displayed |
Options |
getOptions(String key,
FieldConfig config,
JiraContextNode contextNode)
Returns options for this custom field if it is of MultipleCustomFieldType type. |
Options |
getOptions(String key,
JiraContextNode jiraContextNode)
Returns options for this custom field if it is of MultipleCustomFieldType type. |
FieldConfig |
getRelevantConfig(Issue issue)
Returns a relevant FieldConfig for the given issue. |
FieldConfig |
getRelevantConfig(IssueContext issueContext)
Returns the relevant field config of this custom field for the give issue context |
protected CustomFieldParams |
getRelevantParams(Map params)
Returns custom field parameter from the given map that are relevant to this custom field. |
FieldConfig |
getReleventConfig(SearchContext searchContext)
Return the relevant field config for the search context specified. |
org.apache.lucene.search.SortComparatorSource |
getSortComparatorSource()
Return a SortComparatorSource that uses either a custom field searcher that implements SortableCustomFieldSearcher or a custom field that implements SortableCustomField . |
LuceneFieldSorter |
getSorter()
If this field has a searcher, and this searcher implements SortableCustomFieldSearcher then return
SortableCustomFieldSearcher.getSorter(CustomField) . |
Object |
getValue(Issue issue)
Retrieves and returns the Object representing the this CustomField value for the given issue. |
String |
getValueFromIssue(Issue issue)
Gets the value stored for this field on the provided issue. |
Object |
getValueFromParams(Map params)
Get a field value from the map of parameters passed. |
String |
getViewHtml(FieldLayoutItem fieldLayoutItem,
webwork.action.Action action,
Issue issue)
|
String |
getViewHtml(FieldLayoutItem fieldLayoutItem,
webwork.action.Action action,
Issue issue,
Map displayParameters)
|
String |
getViewHtml(FieldLayoutItem fieldLayoutItem,
webwork.action.Action action,
Issue issue,
Object value,
Map displayParameters)
|
protected boolean |
hasBulkUpdatePermission(BulkEditBean bulkEditBean,
Issue issue)
Checks whether the user has the permission to execute the bulk operation for the provided issue. |
int |
hashCode()
|
boolean |
hasValue(Issue issue)
Determines if the field has a value for the given issue. |
boolean |
isAllIssueTypes()
Returns true if it applies for all issue types, false otherwise. |
boolean |
isAllProjects()
Checks whether this custom field applies for all projects. |
boolean |
isEditable()
Returns true if this custom field has an edit template, false otherwise. |
boolean |
isEnabled()
Returns true if all configuration schemes returned by getConfigurationSchemes() are enabled. |
boolean |
isGlobal()
Returns true if this custom field applies for all projects and all issue types. |
boolean |
isInScope(User remoteUser,
org.ofbiz.core.entity.GenericValue project,
List issueTypeIds)
Determines if the custom field based on the entities passed (project or issue type) is in scope. |
boolean |
isInScope(User user,
SearchContext searchContext)
Determines wheteher this custom field is in scope. |
boolean |
isRenderable()
This is the conjunction point with CustomFieldTypes and this is delegated off to customField Types. |
boolean |
isShown(Issue issue)
Tests field specific way to determine if it should be shown or not |
MessagedResult |
needsMove(Collection originalIssues,
Issue targetIssue,
FieldLayoutItem targetFieldLayoutItem)
Used to determine if the field needs input from user to be moved to the new project and/or issue type. |
void |
populateDefaults(Map customFieldValuesHolder,
Issue issue)
Populate the fieldValueHolder with a value that should be shown by default when the issue has not been created yet |
void |
populateForMove(Map fieldValuesHolder,
Issue originalIssue,
Issue targetIssue)
Used to populate the fieldValueHolder with parameters for move issue screen. |
void |
populateFromIssue(Map customFieldValuesHolder,
Issue issue)
Puts the custom field parameters retrieved from the given issue to the given customFieldValuesHolder map. |
void |
populateFromParams(Map customFieldValuesHolder,
Map params)
Puts the relevant parameters from the given params map to the given customFieldValuesHolder map. |
void |
populateParamsFromString(Map fieldValuesHolder,
String stringValue,
Issue issue)
Does nothing. |
String |
prettyPrintChangeHistory(String changeHistory)
Returns the same string. |
String |
prettyPrintChangeHistory(String changeHistory,
I18nHelper i18nHelper)
Returns the same string. |
Set |
remove()
Removes this custom field and returns a set of issue IDs of all issues that are affected by removal of this custom field. |
void |
removeValue(MutableIssue issue)
Removes the value for the given issue. |
void |
setConfigurationSchemes(List configurationSchemes)
Sets the configuration schemes for this custom field. |
void |
setCustomFieldSearcher(CustomFieldSearcher searcher)
Sets the CustomFieldSearcher for this custom field by setting the ENTITY_CUSTOM_FIELD_SEARCHER
underlying generic value attribute to the value of the key retrieved from the searcher. |
void |
setDescription(String description)
Sets the description of this custom field by setting the ENTITY_DESCRIPTION of the underlying generic
value. |
void |
setName(String name)
Sets the name of this custom field by setting the ENTITY_NAME of the underlying generic value. |
void |
store()
Stores the generic value of this custom field and refreshes FieldManager . |
String |
toString()
|
void |
updateIssue(FieldLayoutItem fieldLayoutItem,
MutableIssue issue,
Map fieldValueHolder)
Record the value on the issue (not saving it to the database, see updateValue) |
void |
updateValue(FieldLayoutItem fieldLayoutItem,
Issue issue,
ModifiedValue modifiedValue,
IssueChangeHolder issueChangeHolder)
Update the issue in the data store |
void |
validateFromActionParams(Map actionParameters,
ErrorCollection errorCollection,
FieldConfig config)
Validates relevant parameters on custom field type of this custom field. |
void |
validateParams(OperationContext operationContext,
ErrorCollection errorCollectionToAddTo,
I18nHelper i18n,
Issue issue,
FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem)
Ensure that the parameters are valid |
(package private) boolean |
valuesEqual(Object v1,
Object v2)
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String ENTITY_CF_TYPE_KEY
public static final String ENTITY_CUSTOM_FIELD_SEARCHER
public static final String ENTITY_NAME
public static final String ENTITY_ISSUETYPE
public static final String ENTITY_PROJECT
public static final String ENTITY_ID
public static final String ENTITY_DESCRIPTION
public static final String ENTITY_TABLE_NAME
Constructor Detail |
---|
public CustomFieldImpl(org.ofbiz.core.entity.GenericValue customField, CustomFieldManager customFieldManager, JiraAuthenticationContext authenticationContext, ConstantsManager constantsManager, FieldConfigSchemeManager fieldConfigSchemeManager, PermissionManager permissionManager, RendererManager rendererManager)
Method Detail |
---|
public void store() throws DataAccessException
FieldManager
.
store
in interface CustomField
DataAccessException
- if error of storing the generic value occurspublic boolean isInScope(User remoteUser, org.ofbiz.core.entity.GenericValue project, List issueTypeIds)
isInScope
in interface CustomField
remoteUser
- not usedproject
- project generic valueissueTypeIds
- issue type IDs
public FieldConfig getFirstRelevantConfig(org.ofbiz.core.entity.GenericValue project, List issueTypeIds)
getFirstRelevantConfig
in interface CustomField
project
- projectissueTypeIds
- issue type IDs
public FieldConfig getReleventConfig(SearchContext searchContext)
getReleventConfig
in interface CustomField
searchContext
- search context
public boolean isInScope(User user, SearchContext searchContext)
isInScope
in interface CustomField
user
- not usedsearchContext
- search context
public void validateFromActionParams(Map actionParameters, ErrorCollection errorCollection, FieldConfig config)
CustomFieldType.validateFromParams(CustomFieldParams,ErrorCollection,FieldConfig)
validateFromActionParams
in interface CustomField
actionParameters
- action parameterserrorCollection
- error collection to add errors toconfig
- field configpublic Object getValue(Issue issue)
CustomFieldType.getValueFromIssue(CustomField,Issue)
getValue
in interface CustomField
issue
- issue to retrieve the value from
OrderableField.getValueFromParams(java.util.Map)
public boolean isRenderable()
isRenderable
in interface RenderableField
public void updateValue(FieldLayoutItem fieldLayoutItem, Issue issue, ModifiedValue modifiedValue, IssueChangeHolder issueChangeHolder)
OrderableField
updateValue
in interface OrderableField
fieldLayoutItem
- for this field within this contextissue
- Issue this field is part ofmodifiedValue
- new value to set field to. Cannot be null.issueChangeHolder
- an object to record any changes made to the issue by this method.public String prettyPrintChangeHistory(String changeHistory)
prettyPrintChangeHistory
in interface NavigableField
changeHistory
- change history string
public String prettyPrintChangeHistory(String changeHistory, I18nHelper i18nHelper)
prettyPrintChangeHistory
in interface NavigableField
changeHistory
- change history stringi18nHelper
- not used
public boolean isEditable()
isEditable
in interface CustomField
public Options getOptions(String key, JiraContextNode jiraContextNode)
MultipleCustomFieldType
type. Otherwise returns null.
getOptions
in interface CustomField
key
- not usedjiraContextNode
- JIRA context node
MultipleCustomFieldType
type, null otherwisepublic Options getOptions(String key, FieldConfig config, JiraContextNode contextNode)
MultipleCustomFieldType
type. Otherwise returns null.
getOptions
in interface CustomField
key
- not usedconfig
- relevant field configcontextNode
- JIRA context node
MultipleCustomFieldType
type, null otherwisepublic void populateDefaults(Map customFieldValuesHolder, Issue issue)
OrderableField
populateDefaults
in interface OrderableField
public FieldConfig getRelevantConfig(IssueContext issueContext)
getRelevantConfig
in interface ConfigurableField
getRelevantConfig
in interface CustomField
issueContext
- issue context to find the relevant field config for
public FieldConfig getRelevantConfig(Issue issue)
CustomField
FieldConfig
for the given issue. If the field has
a config for the issue then one will be returned, otherwise null is returned.
For example, if we have 2 projects: project A and project B, and a custom field is configured to be only
applicable to project A, calling getRelevantConfig with an issue from project A should return the config
(i.e. not null). Calling this method with an issue from project B should
rerurn null.
getRelevantConfig
in interface CustomField
issue
- issue whose project and issue type will be used to check if the field has a config
FieldConfig
representing the configuration of the field for issue's
project/issue type. If the field does not have a config for issue's project/issue type, null is returned.public void populateFromParams(Map customFieldValuesHolder, Map params)
populateFromParams
in interface OrderableField
customFieldValuesHolder
- map of custom field valuesparams
- map of parameterspublic void populateFromIssue(Map customFieldValuesHolder, Issue issue)
populateFromIssue
in interface OrderableField
customFieldValuesHolder
- map of custom field valuesissue
- issue to get the custom field parameters frompublic Object getValueFromParams(Map params) throws FieldValidationException
OrderableField
getValueFromParams
in interface OrderableField
FieldValidationException
public void populateParamsFromString(Map fieldValuesHolder, String stringValue, Issue issue)
populateParamsFromString
in interface OrderableField
fieldValuesHolder
- not usedstringValue
- not usedissue
- not used
UnsupportedOperationException
- alwayspublic List getConfigurationItemTypes()
ConfigurableField
FieldConfigItemType
objects. This opens up possibilties for configurable custom fields
getConfigurationItemTypes
in interface ConfigurableField
FieldConfigItemType
@NotNullpublic List getAssociatedSearchers()
SearchableField
getAssociatedSearchers
in interface SearchableField
Class
objects of type @IssueSearcher
. Empty list if no searchers are required.
Must not be nullpublic void createValue(Issue issue, Object value)
OrderableField
createValue
in interface OrderableField
issue
- Issue this field is part ofvalue
- Value to store in this field (eg. Collection for Version fields). Cannot be null.public void validateParams(OperationContext operationContext, ErrorCollection errorCollectionToAddTo, I18nHelper i18n, Issue issue, FieldScreenRenderLayoutItem fieldScreenRenderLayoutItem)
OrderableField
validateParams
in interface OrderableField
issue
- this is passed to get the value of other fields that may or may not have been modifiedpublic CustomFieldParams getCustomFieldValues(Map customFieldValuesHolder)
CustomField
getCustomFieldValues
in interface CustomField
customFieldValuesHolder
- containing all params
CustomFieldParams
of String
objectspublic Set remove() throws DataAccessException
remove
in interface CustomField
DataAccessException
- if removal of generic value failsprotected CustomFieldParams getRelevantParams(Map params)
params
- map of parameters
public String toString()
toString
in class Object
public String getColumnViewHtml(FieldLayoutItem fieldLayoutItem, Map displayParams, Issue issue)
getColumnViewHtml
in interface NavigableField
protected I18nHelper getI18nHelper()
public String getHiddenFieldId()
NavigableField
getHiddenFieldId
in interface NavigableField
public String getCreateHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue)
OrderableField
getCreateHtml
in interface OrderableField
public String getCreateHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue, Map dispayParameters)
OrderableField
getCreateHtml
in interface OrderableField
public String getEditHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue)
OrderableField
getEditHtml
in interface OrderableField
public String getEditHtml(FieldLayoutItem fieldLayoutItem, OperationContext operationContext, webwork.action.Action action, Issue issue, Map dispayParameters)
OrderableField
getEditHtml
in interface OrderableField
public String getBulkEditHtml(OperationContext operationContext, webwork.action.Action action, BulkEditBean bulkEditBean, Map displayParameters)
OrderableField
getBulkEditHtml
in interface OrderableField
public String getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue)
getViewHtml
in interface OrderableField
public String getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, Map displayParameters)
getViewHtml
in interface OrderableField
public String getViewHtml(FieldLayoutItem fieldLayoutItem, webwork.action.Action action, Issue issue, Object value, Map displayParameters)
getViewHtml
in interface OrderableField
public boolean isShown(Issue issue)
OrderableField
isShown
in interface OrderableField
public Object getDefaultValue(Issue issue)
OrderableField
getDefaultValue
in interface OrderableField
public void updateIssue(FieldLayoutItem fieldLayoutItem, MutableIssue issue, Map fieldValueHolder)
OrderableField
updateIssue
in interface OrderableField
public MessagedResult needsMove(Collection originalIssues, Issue targetIssue, FieldLayoutItem targetFieldLayoutItem)
OrderableField
needsMove
in interface OrderableField
public void populateForMove(Map fieldValuesHolder, Issue originalIssue, Issue targetIssue)
OrderableField
OrderableField.needsMove(java.util.Collection,com.atlassian.jira.issue.Issue,com.atlassian.jira.issue.fields.layout.field.FieldLayoutItem)
returned true, and the remote user (the one performing the move) has the permission to actually update this field.
populateForMove
in interface OrderableField
public void removeValue(MutableIssue issue)
OrderableField
removeValue
in interface OrderableField
public boolean hasValue(Issue issue)
OrderableField
hasValue
in interface OrderableField
public String getId()
Field
getId
in interface Field
getId
in interface RenderableField
public String getValueFromIssue(Issue issue)
RenderableField
getValueFromIssue
in interface RenderableField
issue
- identifies the issue that will contain the value for this field.
public Long getIdAsLong()
getIdAsLong
in interface CustomField
public List getConfigurationSchemes()
getConfigurationSchemes
in interface CustomField
FieldConfigScheme
objectspublic void setConfigurationSchemes(List configurationSchemes)
configurationSchemes
- a list of FieldConfigScheme
objectspublic String getNameKey()
Field
getNameKey
in interface Field
public List getAssociatedProjectCategories()
getConfigurationSchemes()
returns null.
It returns an empty list if the getConfigurationSchemes()
returns an empty list.
The returned list is sorted by name using OfBizComparators.NAME_COMPARATOR
.
getAssociatedProjectCategories
in interface CustomField
GenericValue
objects that represent associated project categories
as ProjectCategoryContext
objectspublic List getAssociatedProjects()
CustomField
getAssociatedProjects
in interface ConfigurableField
getAssociatedProjects
in interface CustomField
public List getAssociatedIssueTypes()
CustomField
getAssociatedIssueTypes
in interface CustomField
public boolean isGlobal()
isGlobal
in interface CustomField
public boolean isAllProjects()
isAllProjects
in interface CustomField
public boolean isAllIssueTypes()
getAssociatedIssueTypes()
contains null - all issue types.
isAllIssueTypes
in interface CustomField
public boolean isEnabled()
getConfigurationSchemes()
are enabled.
isEnabled
in interface CustomField
public String availableForBulkEdit(BulkEditBean bulkEditBean)
availableForBulkEdit
in interface OrderableField
bulkEditBean
- bulk edit bean
protected static boolean areDifferent(Object obj1, Object obj2)
obj1
- the first object to compareobj2
- the second object to compare
protected boolean hasBulkUpdatePermission(BulkEditBean bulkEditBean, Issue issue)
bulkEditBean
- bulk edit beanissue
- issue to check permission on
public String getName()
ENTITY_NAME
of the underlying generic value.
getName
in interface Field
public void setName(String name)
ENTITY_NAME
of the underlying generic value.
The name is abbreviated to a number of characters equal to FieldConfigPersister.ENTITY_LONG_TEXT_LENGTH
.
setName
in interface CustomField
name
- name to setpublic String getDescription()
ENTITY_DESCRIPTION
of the underlying generic value.
getDescription
in interface CustomField
public void setDescription(String description)
ENTITY_DESCRIPTION
of the underlying generic
value.
setDescription
in interface CustomField
description
- description to setpublic CustomFieldSearcher getCustomFieldSearcher()
CustomFieldSearcher
for this custom field looking it up in the customFieldManager
by the searcher key retrieved from ENTITY_CUSTOM_FIELD_SEARCHER
underlying generic value attribute.
The seracher, if found is initialized with this custom field before it is returned.
getCustomFieldSearcher
in interface CustomField
public void setCustomFieldSearcher(CustomFieldSearcher searcher)
CustomFieldSearcher
for this custom field by setting the ENTITY_CUSTOM_FIELD_SEARCHER
underlying generic value attribute to the value of the key retrieved from the searcher.
setCustomFieldSearcher
in interface CustomField
searcher
- custom field searcher to associate with this custom fieldpublic CustomFieldType getCustomFieldType()
CustomFieldType
in the customFieldManager
by
the key retrieved from the ENTITY_CF_TYPE_KEY
attribute of the underlying generic value.
This only happens once if type
is null, then the custom field type is set and returned each time.
It can return null if the custom field type cannot be found by that key.
getCustomFieldType
in interface CustomField
public String getColumnHeadingKey()
getColumnHeadingKey
in interface NavigableField
public String getColumnCssClass()
getColumnCssClass
in interface NavigableField
public String getDefaultSortOrder()
NavigableField.ORDER_ASCENDING
.
getDefaultSortOrder
in interface NavigableField
NavigableField.ORDER_ASCENDING
valueboolean valuesEqual(Object v1, Object v2)
public int compare(Issue issue1, Issue issue2) throws IllegalArgumentException
SortableCustomField
If either of given issues is null a IllegalArgumentException is thrown.
compare
in interface CustomField
issue1
- issue to compareissue2
- issue to compare
IllegalArgumentException
- if any of given issues is nullpublic LuceneFieldSorter getSorter()
SortableCustomFieldSearcher
then return
SortableCustomFieldSearcher.getSorter(CustomField)
. Else return null.
getSorter
in interface NavigableField
NavigableField.getSortComparatorSource()
DocumentIssueImpl
,
MappedSortComparator
public org.apache.lucene.search.SortComparatorSource getSortComparatorSource()
SortableCustomFieldSearcher
or a custom field that implements SortableCustomField
.
If neither are found, this method returns null.
getSortComparatorSource
in interface NavigableField
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public org.ofbiz.core.entity.GenericValue getGenericValue()
getGenericValue
in interface CustomField
public int compareTo(Object o)
compareTo
in interface Comparable
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |