Class DocumentTable
java.lang.Object
ru.bitel.bgbilling.plugins.documents.common.bean.DocumentTable
- All Implemented Interfaces:
Cloneable
Класс-модель таблицы в шаблоне документа плагина Documents.
В шаблоне может быть несколько таблиц, отличающихся именами.
Для того, чтобы идентифицировать таблицу в файле шаблона, используется
уникальный идентификатор.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionclone()
Создание копии объекта.boolean
Переопределенный для таблиц шаблона метод сравнения.Возвращает метод получения данных для данной таблицы.Получение уникального идентификатора таблицы, по которому ее можно найти в теле файла шаблона.int
Deprecated.0 возвращается в случае, если значением позиции является строка, которая не может быть преобразована в целое число.getTitle()
Получение названия таблицы.getValue()
Получение значения, содержащегося в данном bean.void
setExtractMethod
(DocumentTableExtractMethod extractMethod) Установка метода получения данных для данной таблицы.void
setIdentifier
(String id) Установка уникального идетификатора таблицы, по которому ее можно найти в теле файла шаблона.void
setPosition
(int position) Deprecated.Обратите внимание, что передаваемое в данном методе целочисленное значение будет преобразовано в строку и в дальнейшем будет использоваться как идентификатор таблицы в файле шаблона с обрамлением фигурными скобками - {position}.void
Установка названия таблицы.void
Установка значения, содержащегося в данном bean.
-
Constructor Details
-
DocumentTable
public DocumentTable() -
DocumentTable
-
-
Method Details
-
getTitle
Получение названия таблицы.- Returns:
- название таблицы.
-
setTitle
Установка названия таблицы.- Parameters:
title
- название таблицы.
-
getPosition
Deprecated.0 возвращается в случае, если значением позиции является строка, которая не может быть преобразована в целое число.ИспользоватьgetIdentifier()
-
setPosition
Deprecated.Обратите внимание, что передаваемое в данном методе целочисленное значение будет преобразовано в строку и в дальнейшем будет использоваться как идентификатор таблицы в файле шаблона с обрамлением фигурными скобками - {position}.ИспользоватьsetIdentifier(String id)
-
getIdentifier
Получение уникального идентификатора таблицы, по которому ее можно найти в теле файла шаблона. В файле шаблона этот идентификатор должен быть обрамлен фигурными скобками, чтобы однозначно выделить его из текста. Например: идентификатор "id", заданный для таблицы, в файле шаблона в нужной таблице должен быть написан в виде "{id}".- Returns:
- уникальный идентификатор таблицы.
- Since:
- 6.2
-
setIdentifier
Установка уникального идетификатора таблицы, по которому ее можно найти в теле файла шаблона. В файле шаблона этот идентификатор должен быть обрамлен фигурными скобками, чтобы однозначно выделить его из текста. Например: идентификатор "id", заданный для таблицы, в файле шаблона в нужной таблице должен быть написан в виде "{id}".- Parameters:
id
- идентификатор- Since:
- 6.2
-
getExtractMethod
Возвращает метод получения данных для данной таблицы. Возможные значения:
DocumentTableExtractMethod.SQL
- sql-запрос к БД, где кол-во выводимых столбцов в запросе должно совпадать с числом столбцов в таблице в файле шаблона.DocumentTableExtractMethod.DYNCLASS
- ссылка на класс из динамического кода, где возможно получить любые данные, оформленные в виде списка пар "ключ-значение".
- Returns:
-
setExtractMethod
Установка метода получения данных для данной таблицы. Возможные значения:
DocumentTableExtractMethod.SQL
- sql-запрос к БД, где кол-во выводимых столбцов в запросе должно совпадать с числом столбцов в таблице в файле шаблона.DocumentTableExtractMethod.DYNCLASS
- ссылка на класс из динамического кода, где возможно получить любые данные, оформленные в виде списка пар "ключ-значение".
- Parameters:
extractMethod
-
-
getValue
Получение значения, содержащегося в данном bean. В зависимости от метода получения данных для данной таблицы, здесь может модержаться либо sql-запрос, либо полное имя класса из динамического кода.- Returns:
- значение.
-
setValue
Установка значения, содержащегося в данном bean. В зависимости от метода получения данных для данной таблицы, здесь может модержаться либо sql-запрос, либо полное имя класса из динамического кода.- Parameters:
value
- значение.
-
equals
Переопределенный для таблиц шаблона метод сравнения. Переопределение необходимо, т.к. сравнение объектов происходит не по id, а по набору title-extractMethod-identifier-value -
clone
Создание копии объекта.
-