com.endeca.infront.cartridge
Class RecordDetailsConfig

java.lang.Object
  java.util.AbstractMap<K,V>
      java.util.HashMap<String,Object>
          com.endeca.infront.assembler.BasicContentItem
              com.endeca.infront.cartridge.RecordDetailsConfig

All Implemented Interfaces:

ContentItem, Serializable, Cloneable, Map<String,Object>

public class RecordDetailsConfig
extends BasicContentItem

RecordDetailsHandler configuration model.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

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

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.
void	setFieldNames(List<String> fieldNames) Specifies which record fields will be passed through from the records to the resulting ContentItem.
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 com.endeca.infront.assembler.BasicContentItem

getBooleanProperty, getIntProperty, getLongProperty, getType, getTypedProperty, setType

Methods inherited from class java.util.HashMap

clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

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:

BasicContentItem.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)