Package io.revealbi.core.data

Class RVDataModelField

java.lang.Object
io.revealbi.core.data.RVDataModelField
Direct Known Subclasses:
RVDataModelCalculatedField
public class RVDataModelField extends Object
Represents a field in the data model.

Used with IRVDataModelProvider to edit the schema of a data source item.

API Note:
This class is part of the beta IRVDataModelProvider API and may change in future releases.

  • Constructor Details

    • RVDataModelField

      public RVDataModelField(String name, RVDashboardDataType type)
      Creates a new data model field with the given name and type.
      Parameters:
      name - The name of the field.
      type - The data type of the field.

  • Method Details

    • getName

      public String getName()
      Returns the name of the field.
      Returns:
      The field name.

    • getLabel

      public String getLabel()
      Returns the label of the field (display name).
      Returns:
      The field label.

    • setLabel

      public void setLabel(String label)
      Sets the label (display name) for the field.
      Parameters:
      label - The label to set.

    • getDescription

      public String getDescription()
      Returns the description of the field.
      Returns:
      The field description.

    • setDescription

      public void setDescription(String description)
      Sets the description for the field.
      Parameters:
      description - The description to set.

    • getType

      public RVDashboardDataType getType()
      Returns the data type of the field.
      Returns:
      The data type.

    • setType

      public void setType(RVDashboardDataType type)
      Sets the data type of the field.
      Parameters:
      type - The data type to set.

    • isWeekLevelEnabled

      public boolean isWeekLevelEnabled()
      Returns whether week-level grouping is enabled for date fields.
      Returns:
      true if week level is enabled.

    • setWeekLevelEnabled

      public void setWeekLevelEnabled(boolean weekLevelEnabled)
      Sets whether week-level grouping is enabled for date fields.
      Parameters:
      weekLevelEnabled - true to enable week level.

    • getDefaultAggregation

      public RVDashboardAggregationType getDefaultAggregation()
      Returns the default aggregation type for this field.
      Returns:
      The default aggregation.

    • setDefaultAggregation

      public void setDefaultAggregation(RVDashboardAggregationType defaultAggregation)
      Sets the default aggregation type for this field.
      Parameters:
      defaultAggregation - The default aggregation to set.