See: Description
Interface | Description |
---|---|
AttributeTrail |
AttributeTrail carries information about what dependencies were used when calculating values for an
attribute. |
RowValues |
An object that implements
RowValues interface is supplied as a result of attributes calculation by
StructureAttributeService . |
StructureAttributeService |
StructureAttributeService provides unified way to retrieve field values, aggregate values or any other
defined attributes for issues or other items. |
TrailItemSet.ReadVisitor |
Alternate visitor interface for reading out the specific items and types.
|
TrailItemSet.Visitor |
Visitor interface for analyzing the set.
|
VersionedRowValues |
This interface extends the basic
RowValues interface, which allows retrieving values calculated by
StructureAttributeService . |
Class | Description |
---|---|
AttributeLoaderSecurity | |
AttributeSpec<T> |
AttributeSpec is the "attribute specification", a composite identifier of an attribute. |
AttributeSpecBuilder<T> | |
AttributeSpecNormalization | |
AttributeTrail.EmptyTrail |
Empty trail implementation
|
CoreAttributeSpecs |
CoreAttributeSpec contains the attribute specifications and related constants for the well-known attributes. |
CoreAttributeSpecs.Format | |
CoreAttributeSpecs.Id | |
CoreAttributeSpecs.Param | |
TrailItemSet |
Abstract class for defining a set of items (by their
ItemIdentity ). |
TrailItemSet.AllItems |
Represents a set of all items.
|
TrailItemSet.Collector |
Used to collect specific types and items stored in the TrailItemSet.
|
TrailItemSet.None |
Represents an empty set.
|
TrailItemSet.OneItem |
Represents a set with just one item.
|
TrailItemSet.OneType |
Represents a set of all items of one specific type.
|
TrailItemSet.SpecificItems |
Represents a set of several sepecific items.
|
TrailItemSet.SpecificTypes |
Represents a set of all items of several specific types.
|
ValueFormat<T> |
ValueFormat is used as a part of AttributeSpec to define in what format the value should be
returned. |
VersionedRowValues.EmptyVersionedRowValues |
Empty result implementation
|
This package provides API for using attributes, a concept added by Structure platform for universal access to item data.
An attribute is something that can be calculated or retrieved for a structure row. The data shown to the users in structure grid is based on attributes.
An attribute is identified by AttributeSpec
. To calculate
the values, client code passes ForestSpec
, row IDs and
attribute specifications to StructureAttributeService
and
receives a matrix with values as a result.
Attributes can be of three kinds:
Attributes are extensible. The specific implementation of an attribute is provided by Structure itself or by
other add-ons. It is therefore important to notice that if an add-on is installed or uninstalled, the implementation
of some attributes may change. For the SPI, see com.almworks.jira.structure.api.attribute.loader
package.
Note: It is important to differentiate attributes from columns. A column in Structure widget displays some HTML to the user. It usually requires one or more attributes to be loaded, it then takes attribute values and displays them somehow (sometimes as-is, sometimes not — for example, Icons column can display concatenated icons, loaded through several attributes.
Copyright © 2019 ALM Works. All Rights Reserved.