ContentSearch Properties

This topic alphabetically lists the properties that apply to the ContentSearch class. Note that this is an internal class used in searches (the class is not exposed via the Content Engine API).

ClassDescription Property



Specifies a ClassDescription object containing the fixed description (immutable metadata) of the class from which this object is instantiated.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: false
IsSearchable: false
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: ClassDescription
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

ContentSummary Property



Represents a document's content summary.

When performing a full-text (CBR) search, avoid referencing the ContentSummary column. The retrieval of this text column can slow the execution of the search.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
MaximumLengthString: null
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

HighlightOffsets Property



This property is not supported.

The offsets in the summary text of a text search result, which represent fragments that should be highlighted as hits.

Metadata

AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
PropertyDefaultInteger32: null
PropertyMaximumInteger32: null
PropertyMinimumInteger32: null
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

QueriedObject Property



The queried Document object that provided the content for the full-text search.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: DMA
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

Rank Property



The level of importance (rank) assigned to documents returned by a full-text query. For IBM Legacy Content Search Engine, this a value from 0.0 to 1.0. For IBM Content Search Services, this is a value from 0 to 1000. A greater value indicates a better match.

You can change the rank value range used for IBM Legacy Content Search Engine to match the value range used by IBM Content Search Services. To change this range, add the parameter "-DCBR.RankConsistency=true" to the Java Virtual Machine (JVM) command used by the Content Engine. The rank value range returned by both IBM Legacy Content Search Engine and IBM Content Search Services will then be 0 to 1000.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: DOUBLE
IsHidden: false
IsOrderable: true
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ