com.endeca.infront.cartridge

Class RecordDetailsConfig

java.lang.Object

BasicContentItem

com.endeca.infront.cartridge.RecordDetailsConfig

public class RecordDetailsConfig
extends BasicContentItem

RecordDetailsHandler configuration model.

Constructor Summary

Constructors

Constructor and Description
RecordDetailsConfig() Creates an empty RecordDetailsConfig.
RecordDetailsConfig(ContentItem pContentItem) Creates a copy of the specified ContentItem, and returns it as an instance of RecordDetailsConfig.
RecordDetailsConfig(String pType) Creates an empty RecordDetailsConfig with the specified type.

Method Summary

Modifier and Type	Method and Description
List<String>	getFieldNames() Returns the record fields that will be returned in the ContentItem.
List<String>	getSubRecordFieldNames() Returns the sub-record fields (of aggregate records) that will be returned in the ContentItem.
boolean	isIncludeDerivedProperties()
boolean	isIncludeGeoProperties()
boolean	isIncludeSnippetProperties()
void	setFieldNames(List<String> fieldNames) Specifies which record fields will be passed through from the records to the resulting ContentItem.
void	setIncludeDerivedProperties(boolean includeDerivedProperties)
void	setIncludeGeoProperties(boolean includeGeoProperties)
void	setIncludeSnippetProperties(boolean includeSnippetProperties)
void	setSubRecordFieldNames(List<String> fieldNames) Specifies which sub-record fields (of aggregate records) will be passed through to the resulting ContentItem.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RecordDetailsConfig

public RecordDetailsConfig()

Creates an empty RecordDetailsConfig.

RecordDetailsConfig

public RecordDetailsConfig(String pType)

Creates an empty RecordDetailsConfig with the specified type.

Parameters:

pType - a value that will be used as the type

See Also:

#getType()

RecordDetailsConfig

public RecordDetailsConfig(ContentItem pContentItem)

Creates a copy of the specified ContentItem, and returns it as an instance of RecordDetailsConfig.

Method Detail

setFieldNames

public void setFieldNames(List<String> fieldNames)

Specifies which record fields will be passed through from the records to the resulting ContentItem. If null, the default set of field names configured for the MDEX (from render_config.xml) will be returned.

If aggregation is enabled, this list is used to specify the record field names for the aggregated records, and the subRecordFieldNames list is used to specify the record field names for the sub-records (child) records.

If aggregation is disabled and a subRecordFieldNames list is also specified, it will be combined with this list.

See Also:

getFieldNames(), getSubRecordFieldNames()

getFieldNames

public List<String> getFieldNames()

Returns the record fields that will be returned in the ContentItem.

Returns:

record fields to return. May be null, in which all configured record fields will be returned.

See Also:

setFieldNames(java.util.List), setSubRecordFieldNames(java.util.List)

setSubRecordFieldNames

public void setSubRecordFieldNames(List<String> fieldNames)

Specifies which sub-record fields (of aggregate records) will be passed through to the resulting ContentItem.

If aggregation is enabled and this list is null, all field names configured for the MDEX (from render_config.xml) will be returned on the sub-records (child records). The field names specified by setFieldNames(java.util.List) will be used to determine the field names returned on the aggregated records.

If aggregation is disabled and this list is non-null, its field names will be combined with the field names specified by setFieldNames(java.util.List); the combined list will be used to determine the field names that should be returned on the non-aggregated records.

See Also:

getSubRecordFieldNames(), getFieldNames()

getSubRecordFieldNames

public List<String> getSubRecordFieldNames()

Returns the sub-record fields (of aggregate records) that will be returned in the ContentItem. If aggregation is disabled, this list is combined with the fieldNames.

Returns:

sub-record fields to return. May be null, in which all configured sub-record fields will be returned.

See Also:

setSubRecordFieldNames(java.util.List), setFieldNames(java.util.List)

isIncludeDerivedProperties

public boolean isIncludeDerivedProperties()

setIncludeDerivedProperties

public void setIncludeDerivedProperties(boolean includeDerivedProperties)

isIncludeSnippetProperties

public boolean isIncludeSnippetProperties()

setIncludeSnippetProperties

public void setIncludeSnippetProperties(boolean includeSnippetProperties)

isIncludeGeoProperties

public boolean isIncludeGeoProperties()

setIncludeGeoProperties

public void setIncludeGeoProperties(boolean includeGeoProperties)