Package com.stimulsoft.report.dictionary

Class StiDataColumn

java.lang.Object
com.stimulsoft.report.dictionary.StiDataColumn
All Implemented Interfaces:
IStiJsonReportObject, IStiSerializable, IStiSerializableToString, IStiName, IStiInherited
Direct Known Subclasses:
StiCalcDataColumn
public class StiDataColumn extends Object implements IStiSerializable, IStiSerializableToString, IStiName, IStiInherited, IStiJsonReportObject

  • Constructor Details

    • StiDataColumn

      public StiDataColumn()
      by serializing.

    • StiDataColumn

      public StiDataColumn(String name, String alias, StiSystemType systemType)
      Creates a new object of the type StiDataColumn.
      Parameters:
      name - Name of column.
      alias - Alias of column.
      type - Type of data of column.

    • StiDataColumn

      public StiDataColumn(String nameInSource, String name, String alias, StiSystemType systemType)
      Creates a new object of the type StiDataColumn.
      Parameters:
      name - Name of column.
      alias - Alias of column.
      type - Type of data of column.

  • Method Details

    • isTypeWasChanged

      public boolean isTypeWasChanged()

    • setTypeWasChanged

      public void setTypeWasChanged(boolean typeWasChanged)

    • isTypeWasAutoDetected

      public boolean isTypeWasAutoDetected()

    • setTypeWasAutoDetected

      public void setTypeWasAutoDetected(boolean typeWasAutoDetected)

    • setSystemType

      public void setSystemType(StiSystemType systemType)
      Parameters:
      systemType - the systemType to set

    • getKey

      public String getKey()
      Returns:
      the key

    • setKey

      public void setKey(String key)
      Parameters:
      key - the key to set

    • getName

      public final String getName()
      Gets or sets a column name.
      Specified by:
      getName in interface IStiName

    • setName

      public final void setName(String value)
      Specified by:
      setName in interface IStiName

    • setCorrectName

      public final void setCorrectName(String value)

    • getInherited

      public final boolean getInherited()
      Specified by:
      getInherited in interface IStiInherited

    • setInherited

      public final void setInherited(boolean value)
      Specified by:
      setInherited in interface IStiInherited

    • getDataSource

      public final StiDataSource getDataSource()
      Gets or sets the Data Source in what the column is described.

    • setDataSource

      public final void setDataSource(StiDataSource value)

    • getBusinessObject

      public final StiBusinessObject getBusinessObject()
      Gets or sets the Business Object in what the column is described.

    • setBusinessObject

      public final void setBusinessObject(StiBusinessObject value)

    • getIndex

      public final int getIndex()
      Gets or sets the index of a column in the collection of columns.

    • setIndex

      public final void setIndex(int value)

    • getNameInSource

      public final String getNameInSource()
      Gets or sets a original name.

    • setNameInSource

      public final void setNameInSource(String value)

    • getAlias

      public final String getAlias()
      Gets or sets an alias of column data.

    • setAlias

      public final void setAlias(String value)

    • getType

      public final StiSystemTypeEnum getType()
      Gets or sets the type of column data.

    • GetDataFromDataColumn

      public static Object GetDataFromDataColumn(StiDictionary dictionary, String column)

    • GetRelationName

      public static String GetRelationName(StiDictionary dictionary, StiDataSource dataSource, String relationName)

    • GetDataFromBusinessObject

      public static Object GetDataFromBusinessObject(StiDictionary dictionary, String column)

    • GetBusinessObjectFromDataColumn

      public static StiBusinessObject GetBusinessObjectFromDataColumn(StiDictionary dictionary, String column)

    • IsDataPathExists

      public static boolean IsDataPathExists(StiDictionary dictionary, String path)
      Returns true if the path exists in the Data Source or Business Object.
      Parameters:
      dictionary -
      path -
      Returns:

    • GetDataFromDataColumn

      public static Object GetDataFromDataColumn(StiDictionary dictionary, String column, boolean useRelationName)
      Returns object from the Data Source with full name of column.
      Parameters:
      dictionary - Dictionary which contain Data Source.
      column - Full name of column.
      Returns:
      Returned object.

    • getColumnPath

      public String getColumnPath()

    • GetDataSourceFromDataColumn

      public static StiDataSource GetDataSourceFromDataColumn(StiDictionary dictionary, String column)
      Returns Data Source from the full name of column.
      Parameters:
      dictionary - Dictionary which contain Data Source.
      column - Full name of column.
      Returns:
      Data Source.

    • getDataListFromDataColumn

      public static List<Object> getDataListFromDataColumn(StiDictionary dictionary, String column, Integer maxRows)
      Returns list of object from the Data Source with specified DataColumn.
      Parameters:
      dictionary - Dictionary which contain Data Source.
      column - Full name of column.
      maxRows - Returned list of object.
      Returns:

    • getDatasFromDataColumn

      public static ArrayList<Object> getDatasFromDataColumn(StiDictionary dictionary, String column, Integer maxRows)
      Returns array of object from the Data Source with specified DataColumn.
      Parameters:
      dictionary - Dictionary which contain Data Source.
      column - Full name of column.
      maxRows -
      Returns:
      Returned array of object.

    • GetColumnNameFromDataColumn

      public static String GetColumnNameFromDataColumn(StiDictionary dictionary, String column)
      Returns column name from the full name of column.
      Parameters:
      dictionary - Dictionary which contain Data Source.
      column - Full name of column.
      Returns:
      Column name.

    • GetDatasFromDataColumn

      public static Object[] GetDatasFromDataColumn(StiDictionary dictionary, String column)
      Returns array of object from the Data Source with specified DataColumn.
      Parameters:
      dictionary - Dictionary which contain Data Source.
      column - Full name of column.
      Returns:
      Returned array of object.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • serialize

      public String serialize()
      Specified by:
      serialize in interface IStiSerializableToString

    • getTypeOrUserType

      protected String getTypeOrUserType()

    • deserialize

      public void deserialize(String strObject)
      Specified by:
      deserialize in interface IStiSerializableToString

    • setTypeOrUserType

      public void setTypeOrUserType(String systemTypeName)

    • getSystemType

      public StiSystemType getSystemType()
      Returns:
      the systemType

    • getDataFromDataColumnStr

      public static String getDataFromDataColumnStr(StiDictionary dictionary, String column)

    • getCaption

      public String getCaption()
      Returns:
      the caption

    • setCaption

      public void setCaption(String caption)
      Parameters:
      caption - the caption to set

    • getDataColumnFromColumnName

      public static StiDataColumn getDataColumnFromColumnName(StiDictionary dictionary, String column, boolean allowRelationName)

    • SaveToJsonObject

      public JSONObject SaveToJsonObject(StiJsonSaveMode mode) throws JSONException
      Specified by:
      SaveToJsonObject in interface IStiJsonReportObject
      Throws:
      JSONException

    • LoadFromJsonObject

      public void LoadFromJsonObject(JSONObject jObject) throws JSONException
      Specified by:
      LoadFromJsonObject in interface IStiJsonReportObject
      Throws:
      JSONException

    • isArray

      public boolean isArray()

    • getDatasFromDataSourceWithExpression

      public static Object[] getDatasFromDataSourceWithExpression(Object data, String expression, Integer maxRows, boolean firstPositionInDataSource)
      Returns array of objects from the Data Source or Business Object with specified expression.
      Parameters:
      data -
      expression -
      maxRows -
      firstPositionInDataSource -
      Returns:

    • clone

      public Object clone()
      Overrides:
      clone in class Object