Package lumis.portal.bigdata
Class DocumentTypeField
- java.lang.Object
-
- lumis.portal.bigdata.DocumentTypeField
-
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
CompositeDocumentTypeField
@StableMinor(version="14.0", sinceVersion="8.1") public class DocumentTypeField extends Object implements Serializable
Represents a definition of a given field of aDocumentType
.- Since:
- 8.1.0
- Version:
- $Revision: 24477 $ $Date: 2021-04-28 11:30:36 -0300 (Wed, 28 Apr 2021) $
- See Also:
DocumentTypeFields
,IDocumentTypeFieldBuilder
, Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
DocumentTypeField.DataType
Available field data types.static class
DocumentTypeField.IndexMode
Index mode.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected <T extends DocumentTypeField>
TcloneAsMutable()
Returns a mutable copy of this document type field.boolean
equals(Object obj)
String
getAnalyzer()
Returns this field analyzer.
The analyzer is an identifier that must be recognized by the currentIBigDataRepository
implementation.DocumentTypeField.DataType
getDataType()
Returns the data type of this field.String
getFullId()
Returns the full identifier of this field (the parent full identifier concatenated with thelocal
identifier).DocumentTypeField.IndexMode
getIndexMode()
Returns the index mode.String
getLocalId()
This field identifier.CompositeDocumentTypeField
getParentField()
Returns this field's parent field, if any.int
hashCode()
boolean
isAggregatable()
Returns whether this field's value is aggregatable.boolean
isIncludeInGlobalSearch()
Returns whether this field should be included in global search field.
Some big data implementations have a special field that is a flat field that usually receives the values from all other fields.boolean
isList()
Returns whether this field's value is a list.String
toString()
-
-
-
Method Detail
-
getIndexMode
public DocumentTypeField.IndexMode getIndexMode()
Returns the index mode.- Returns:
- the index mode.
- Since:
- 8.1.0
-
isIncludeInGlobalSearch
public boolean isIncludeInGlobalSearch()
Returns whether this field should be included in global search field.
Some big data implementations have a special field that is a flat field that usually receives the values from all other fields. This flag indicates whether this field should be included in the global search field.- Returns:
- whether this field should be included in global search field.
- Since:
- 8.1.0
-
getDataType
public DocumentTypeField.DataType getDataType()
Returns the data type of this field.- Returns:
- the data type of this field.
- Since:
- 8.1.0
-
isList
public boolean isList()
Returns whether this field's value is a list.- Returns:
- whether this field's vlaue is a list.
- Since:
- 8.1.0
-
isAggregatable
public boolean isAggregatable()
Returns whether this field's value is aggregatable.- Returns:
- whether this field's vlaue is aggregatable.
- Since:
- 9.0.0
-
getAnalyzer
public String getAnalyzer()
Returns this field analyzer.
The analyzer is an identifier that must be recognized by the currentIBigDataRepository
implementation.- Returns:
- this field analyzer.
- Since:
- 8.1.0
-
getLocalId
public String getLocalId()
This field identifier.- Returns:
- field identifier.
- Since:
- 8.1.0
-
getFullId
public String getFullId()
Returns the full identifier of this field (the parent full identifier concatenated with thelocal
identifier).- Returns:
- the full identifier of this field (the parent full identifier concatenated with the
local
identifier). - Since:
- 8.1.0
-
getParentField
public CompositeDocumentTypeField getParentField()
Returns this field's parent field, if any.- Returns:
- this field's parent field, if any.
- Since:
- 8.1.0
-
cloneAsMutable
protected <T extends DocumentTypeField> T cloneAsMutable()
Returns a mutable copy of this document type field.- Returns:
- a mutable copy of this document type field
- Since:
- 8.1.0
-
-