Package com.broadleafcommerce.metadata.dsl.core.extension.columns

Interface DerivedColumn<C extends DerivedColumn<C>>

All Superinterfaces:

Column<C>, Comparable<C>, Component<C>, Copyable<C>, CustomCssComponent<C>, Serializable

All Known Implementing Classes:

DefaultDerivedColumn

public interface DerivedColumn<C extends DerivedColumn<C>>
extends Column<C>

Represents the metadata for a ColumnTypes.DERIVED column component. These columns derive their values from that of other fields on the entity. The default column type is ColumnTypes.STRING. The values will only be derived if undefined—not if the column has a value including null unless deriveIfNull() is true. This component does not perform any transformations, unlike DerivedField.

Author:

Nathan Moore (nathandmoore)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	DerivedColumn.Attributes

Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.Column

Column.ColumnAttributes

Field Summary

Fields inherited from interface com.broadleafcommerce.metadata.dsl.core.CustomCssComponent

CSS_ATTRIBUTE

Method Summary

Modifier and Type	Method	Description
default C	columnType(String type)	Set the type of column to render such as STRING or INTEGER.
default C	deriveIfNull()	If set to true, then null values are treated the same as undefined and the display value will be derived.
default C	deriveIfNull(boolean deriveIfNull)
default C	removeColumnType()
default C	removeDeriveIfNull()
default C	removeSource()
default C	source(String source)	The source field on the entity.

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Column

addCellCssClass, addCellCssClass, addCellCssClass, addHeaderCssClass, addHeaderCssClass, addHeaderCssClass, align, alignCenter, alignLeft, alignRight, clearCellCssClasses, clearHeaderCssClasses, colSpan, colSpan, filterAndSortAlias, getAlign, getColSpan, getDataCellCssClasses, getHeaderCssClasses, getName, getWidth, isSortable, name, notSortable, removeCellCssClass, removeCellCssClass, removeCellCssClass, removeHeaderCssClass, removeHeaderCssClass, removeHeaderCssClass, setAlign, setColSpan, setName, setSortable, setWidth, sortable, sortable, width

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Component

addAction, addAction, addComponent, addEndpoint, addEndpoint, apply, attribute, augmentationKey, classifier, clearConditionals, clearEndpoints, conditional, conditionals, description, description, findAction, findAction, findActions, findAttribute, findAttribute, findComponent, findComponent, findComponents, findEndpoint, findEndpoint, findEndpoint, findEndpoints, get, get, getAction, getAction, getActions, getActionsList, getAttribute, getAttribute, getAttributes, getAugmentationKey, getClassifier, getComponent, getComponent, getComponents, getComponentsList, getConditionals, getDescription, getEndpoint, getEndpoint, getEndpoints, getEndpointsList, getId, getLabel, getOrder, getScope, getType, hasAction, hasAttribute, hasComponent, hasEndpoint, id, isAugmentable, isTranslatable, label, label, notTranslatable, order, removeAction, removeAttribute, removeComponent, removeEndpoint, scope, self, setActions, setAttributes, setAugmentationKey, setClassifier, setComponents, setConditionals, setDescription, setEndpoints, setId, setLabel, setOrder, setScope, setTranslatable, setType, translatable, translatable, type

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Copyable

copy

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.CustomCssComponent

addCssClass, addCssClass, addCssClass, clearCssClasses, getCssClasses, removeCssClass, removeCssClass, removeCssClass

Method Details

source

default C source(String source)

The source field on the entity. Use $parent to reference a field on the parent entity.

columnType

default C columnType(String type)

Set the type of column to render such as STRING or INTEGER.

deriveIfNull

default C deriveIfNull()

If set to true, then null values are treated the same as undefined and the display value will be derived.

deriveIfNull

default C deriveIfNull(boolean deriveIfNull)

removeSource

default C removeSource()

removeColumnType

default C removeColumnType()

removeDeriveIfNull

default C removeDeriveIfNull()