Универсальная коллекция. Класс-надстройка

 - Массив
 - СписокЗначений
 - Структура
 - Соответствие
 - ТаблицаЗначений
 - ФиксированныйМассив
 - ФиксированнаяСтруктура
 - ФиксированноеСоответствие

#Область СлужебныйПрограммныйИнтерфейс

// Инициализация класса для работы с коллекцией
// Тип коллекции определяется переданными данными
//
// Параметры:
//  
//  пИсточник - Строка,Тип,Массив,Структура,Соответствие,СписокЗначений,ТаблицаЗначений,ФиксированныйМассив,ФиксированнаяСтруктура,ФиксированноеСоответствие - описание коллекции для последующей инициализации
//                Если передана строка, то в ней ожидается наименование коллекции. В данном случае будет создана новая коллекция
//                Передача типа коллекции, также приведёт к созданию новой коллекции
//                Передача непосредственно универсальной коллекции просто инициализирует класс для дальнейшей работы с ней
//  пПараметрыКонструктора - Массив,Структура,Соответствие,Неопределено - Если задано, то передаст параметры для конструктора
//                Используется для инициализации фиксированных коллекций
//                Для списка значений допустима передача массива. В этом случае список будет инициализирован со значениями из массива
//
// Возвращаемое значение:
//   Булево - Истина, если инициализация выполнена успешно
//
Функция Инициализировать(пИсточник, пПараметрыКонструктора = Неопределено) Экспорт
	
КонецФункции

#КонецОбласти

#Область ПрограммныйИнтерфейс

#Область Итератор_1_0

// Сбрасывает позицию курсора в начальное положение
// Действие необходимо, чтобы начать перебор элементов после того как он был начат,
// но по какой-либо причине прекращён
//
// Параметры:
//  нет передаваемых параметров
//
Процедура Сбросить() Экспорт
	
КонецПроцедуры

// Метод итератора коллекции
// Сдвигает позицию итератора на заданный шаг итератора
// При первом вызове позиционирование производится на первый элемент коллекции при положительном шаге итератора
// При первом вызове позиционирование производится на последний элемент коллекции при отрицательном  шаге итератора
//
// Параметры:
//  
//  пШагИтератора - Число - Шаг итератора. Может быть отрицательным. По умолчанию = 1
//
// Возвращаемое значение:
//   Булево - Истина - итератор спозиционировался на следующий элемент. Ложь - следующий элемент отсутствует
//
Функция Следующий(пШагИтератора = 1) Экспорт
	
КонецФункции

// Получение ключа текущего элемента колллекции
// Для массивов, таблиц итд это будет индекс элемента
// Для структур и соответствий это будет Ключ из пары КлючИЗначение
//
// Параметры:
//  нет передаваемых параметров
//
// Возвращаемое значение:
//   Число,Строка,Произвольный - ключ текущего элемента коллекции
//
Функция Ключ() Экспорт
	
КонецФункции

// Получение значение текущего элемента колллекции
// Для массивов это будет сам элемент, для таблиц строка таблицы,
// для структур, соответствий и списка значений содержимое поля Значение элемента коллекции
// Для структур и соответствий это будет Значение из пары КлючИЗначение
//
// Параметры:
//  нет передаваемых параметров
//
// Возвращаемое значение:
//   Произвольный - значение текущего элемента коллекции
//
Функция Значение() Экспорт
	
КонецФункции

#КонецОбласти

#Область Изменение_1_0

// Добавляет элемент в коллекцию
//
// Параметры:
//  
//  пЗначение - Произвольный - Добавляемое значение
//                 Для таблицы либо не обязательно, либо данные заполнения для новой строки
//                 Если данные заполнения будут переданы, то добавляемая строка таблицы будет заполнена из них 
//  пКлюч - Число,Строка,Произвольный - Ключ элемента коллекции
//                 Массив,СписокЗначений,ТаблицаЗначений - не обязательно. Если ключ указан, то производится вставка в позицию ключа
//                 Структура,Соответствие - обязательно, должен быть уникальным.
//
// Возвращаемое значение:
//   Число,Строка,Произвольный - ключ добавленного элемента 
//
Функция Добавить(пЗначение = "UFL_ШифрПараметрНеПередан", пКлюч = "UFL_ШифрПараметрНеПередан") Экспорт

КонецФункции

// Производит вставку значения в указанную позицию коллекции
// Реализовано как синтаксический сахар и для совместимости с
// существующим кодом, так как метод Добавить() реализует обе команды и Добавить() и Вставить()
//
// Параметры:
//  
//  пЗначение - Произвольный - вставляемое значение
//                 Для таблицы либо не обязательно, либо данные заполнения для новой строки
//                 Если данные заполнения будут переданы, то вставляемая строка таблицы будет заполнена из них 
//  пКлюч - Число,Строка,Произвольный - Ключ позиции коллекции, куда прпоизводится вставка
//
// Возвращаемое значение:
//   Число,Строка,Произвольный - ключ вставленного элемента 
//
Функция Вставить(пКлюч, пЗначение) Экспорт

КонецФункции

// Удалить элемент(ы) с указанным ключом(ами)
//
// Параметры:
//  
//  пКлюч - Массив,Произвольный - ключ(и) удаляемого элемента
//                 Число - числовой ключ(индекс) элемента
//                 Массив - массив ключей
//                 Произвольный - ключ для соответствия
//                 Если будет передан хотя бы один несуществующий ключ, то будет вызвано исключение
//                 Наличие неуникальных ключей допускается
//                 
Процедура Удалить(пКлюч) Экспорт
	
КонецПроцедуры

// Удалить элемент(ы) с указанным значением(ями)
//
// Параметры:
//  
//  пЗначение - Произвольный,Массив - значение или массив значений подлежащих удалению
//  пВсеНайденные - Булево - Истина - удалить все найденные элементы, иначе, только первое найденное
//                 
Процедура УдалитьЗначение(пЗначение, пВсеНайденные = Истина) Экспорт
	
КонецПроцедуры

Процедура Очистить() Экспорт
	
КонецПроцедуры
	
#КонецОбласти

#Область Индексирование_1_0

// Включение индексации содержимого коллекции для ускорения поиска
// Рекомендации по использованию:
// - Выполнять после того как завершена модификация коллекции, так как процедура индесирования довольно тяжелая
//  ВАЖНО! Вызов метода приводит обнулению прогресса итератора
//
// Параметры:
//  
//  пПараметры - Произвольный - некоторые коллекции требуют передачи параметров для индексирования
//                 ТаблицаЗначений: ожидается Строка или Массив строк являющихся индексом
//                 	ВАЖНО! Если необходимо добавить несколько индексов, то передавать массив строк.
//
Процедура Индексировать(пПараметры = Неопределено) Экспорт
	
КонецПроцедуры

// Отключение индексирования и удаление индекса поиска
//
// Параметры:
//  нет передаваемых параметров
//
Процедура УдалитьИндекс() Экспорт
	
КонецПроцедуры

#КонецОбласти

#Область ПоискПолучениеДанных_0_85

// Значение элемента коллекции с указанным ключом
//
// Параметры:
//  
//  пКлюч - Число,Строка,Произвольный - Ключ элемента коллекции
//
// Возвращаемое значение:
//   Произвольный - значение элемента коллекции
//
Функция ПолучитьЗначение(пКлюч) Экспорт
	
КонецФункции

// Ключ первого элемента содержащего значение
// При активированном индексаторе поиск будет производиться с использованием индекса
//
// Параметры:
//  
//  пЗначение - Произвольный - значение, которое необходимо найти
//  пПараметрыПоиска - Произвольный - параметры поиска необходимые для некоторых коллекций
//                 ТаблицаЗначений может принимать имена колонок в которых надлежит производить поиск
//  пВыбратьПервые - Число - количество позиций вхождения, которые необходимо вернуть
//                 Если 1 (по умолчанию), то вернётся первый ключ, по которому найдено значение
//                 Если 0 (по умолчанию), то вернутся все ключи, по которым найдено значение. Аналогично методу НайтиВсеПоЗначению()
//
// Возвращаемое значение:
//   Число,Строка,Произвольный - описание возвращаемого значения
//
Функция НайтиПоЗначению(пЗначение, пПараметрыПоиска = Неопределено, пВыбратьПервые = 1) Экспорт
	
КонецФункции

// Массив ключей всех элементов содержащих переданное значение
// При активированном индексаторе поиск будет производиться с использованием индекса
//
// Параметры:
//  
//  пЗначение - Произвольный - значение, которое необходимо найти
//  пПараметрыПоиска - Произвольный - параметры поиска необходимые для некоторых коллекций
//                 ТаблицаЗначений может принимать имена колонок в которых надлежит производить поиск
//
// Возвращаемое значение:
//   Массив - массив ключей элементов, содержащих искомое значение
//
Функция НайтиВсеПоЗначению(пЗначение, пПараметрыПоиска = Неопределено) Экспорт
	
КонецФункции

// Все значения коллекции
//
// Параметры:
//
//  пОтбор - Произвольный - В данной версии не поддерживается. 
//                 Находится здесь, чтобы резервировать место в сигнатуре метода
//  пТолькоУникальные - Булево - Если Истина, то будут выгружены только уникальные значения
//
// Возвращаемое значение:
//   Массив - значения коллекции
//
Функция ВыгрузитьЗначения(пОтбор = Неопределено, пТолькоУникальные = Ложь) Экспорт
	
КонецФункции

// Список всех ключей коллекции
//
// Параметры:
//  нет передаваемых параметров
//
// Возвращаемое значение:
//   Массив - ключи коллекции
//
Функция ВыгрузитьКлючи() Экспорт
	
КонецФункции

#КонецОбласти

#Область КопированиеИКонвертация_0_85

// Копирование коллекцию в другую коллекцию аналогичного типа
//
// Параметры:
//  
//  пРекурсивно - Булево - Если истина, то все коллекции содержащиеся в исходной коллекции будут так-же скопированы
//                 Иначе, наличные коллекции попадут в копию родительской коллекции как указатели на исходные
//
// Возвращаемое значение:
//   Массив,Структура,Соответствие,СписокЗначений,ТаблицаЗначений,ФиксированныйМассив,ФиксированнаяСтруктура,ФиксированноеСоответствие - копия коллекции
//
Функция Скопировать(пРекурсивно = Истина) Экспорт
	
КонецФункции

// Формирование фиксированной копии универсальной коллекции
//
// Параметры:
//  
//  пРекурсивно - Булево - данные коллекции по возможности будут скопированы и зафиксированы рекурсивно
//
// Возвращаемое значение:
//   ФиксированныйМассив,ФиксированнаяСтруктура,ФиксированноеСоответствие - зафиксированные данные
//
Функция СкопироватьКакЗафиксированныеДанные(пРекурсивно = Истина) Экспорт
	
КонецФункции

// Формирование копии фиксированной коллекции без фиксации
//
// Параметры:
//  
//  пРекурсивно - Булево - данные коллекции будут скопированы и по необходимости зафиксированы рекурсивно
//
// Возвращаемое значение:
//   Массив,Структура,Соответствие - не зафиксированные данные
//
Функция СкопироватьКакДанныеБезФиксации(пРекурсивно = Истина) Экспорт
	
КонецФункции

#КонецОбласти

#Область Свойства

Функция Указатель() Экспорт
	
КонецФункции

Функция ЭтоФиксированнаяКоллекция() Экспорт
	
КонецФункции

Функция ТипКоллекции() Экспорт
	
КонецФункции

Функция Количество() Экспорт
	
КонецФункции
	
#КонецОбласти

#КонецОбласти

Функциональный аналог метода БСП ОбщегоНазначенияКлиентСервер.СкопироватьРекурсивно()

Коллекция = ЭкземплярКлассаУниверсальнаяКоллекция(пОбъект);
	      
Если Не Коллекция.ЭтоФиксированнаяКоллекция() Тогда 
   ТипКопии = Коллекция.ТипКоллекции();
Иначе
   ТипКопии = ТипНеФиксАналогаКоллекции(Коллекция.ТипКоллекции());
КонецЕсли;
КопияКоллекции = ЭкземплярКлассаУниверсальнаяКоллекция(ТипКопии);
	
Пока Коллекция.Следующий() Цикл
   Значение = СкопироватьЗначение(Коллекция.Значение(), пРекурсивно);
   КопияКоллекции.Добавить(Значение, Коллекция.Ключ());
КонецЦикла;
	
Результат = КопияКоллекции.Указатель(); 
Если Коллекция.ЭтоФиксированнаяКоллекция() Тогда
   // данные фикс коллекции копируются в обычной коллекции
   КопияКоллекции = ЭкземплярКлассаУниверсальнаяКоллекция(Результат);
   Результат = КопияКоллекции.СкопироватьКакЗафиксированныеДанные(пРекурсивно);
КонецЕсли;
	
Возврат Результат;

 Функциональный аналог метода БСП ОбщегоНазначения.ФиксированныеДанные()

Функция ЗафиксироватьКоллекциюРекурсивно(пОбъект)
	
   Коллекция = ЭкземплярКлассаУниверсальнаяКоллекция(пОбъект);
   ТипКоллекции = Коллекция.ТипКоллекции();
   КопияКоллекции = ЭкземплярКлассаУниверсальнаяКоллекция(ТипКоллекции);
	
   Пока Коллекция.Следующий() Цикл
      Значение = Коллекция.Значение();
      ТипЗначенияЭлемента = ТипЗнч(Значение);
      ТипФиксАналогаЭлемента = ТипФиксАналогаКоллекции(ТипЗначенияЭлемента);
      Если ТипФиксАналогаЭлемента <> Неопределено Тогда
         Значение = ЗафиксироватьКоллекциюРекурсивно(Значение);
      КонецЕсли;
      КопияКоллекции.Добавить(Значение, Коллекция.Ключ());
   КонецЦикла;

   ТипФиксАналога = ТипФиксАналогаКоллекции(ТипКоллекции);
   ПараметрыКонструктора = Новый Массив;
   ПараметрыКонструктора.Добавить(КопияКоллекции.Указатель());
   Результат = Новый(ТипФиксАналога, ПараметрыКонструктора);
	
   Возврат Результат;
	
КонецФункции

Функция ТестИтератор() Экспорт
	
   ГСЧ = Новый ГенераторСлучайныхЧисел;
   МассивСлучайныхЧисел = Новый Массив;
   МаксЗначение = 10;
   ЧислоЭлементовМассива = 10;
   Для Сч = 1 По ЧислоЭлементовМассива Цикл
      МассивСлучайныхЧисел.Добавить(ГСЧ.СлучайноеЧисло(1, МаксЗначение));
   КонецЦикла;
   Сообщить("Данные для тестирования " + СтрСоединить(МассивСлучайныхЧисел, ","));
	
   ВариантыШагаИтератора = Новый Массив;
   ВариантыШагаИтератора.Добавить(1);
   ВариантыШагаИтератора.Добавить(2);
   ВариантыШагаИтератора.Добавить(-1);
	
   ТестОбъект = КоллекцииКлиентСервер_бук.ЭкземплярКлассаУниверсальнаяКоллекция(МассивСлучайныхЧисел);
   Для Каждого ШагИтератора Из ВариантыШагаИтератора Цикл
      ТестОбъект.Сбросить();
      Результат = Новый Массив;
      Пока ТестОбъект.Следующий(ШагИтератора) Цикл
         Результат.Добавить(ТестОбъект.Значение());
      КонецЦикла;
      Сообщить("Обход шагом " + ШагИтератора + ">>>" + СтрСоединить(Результат, ","));
   КонецЦикла;
		
КонецФункции

Пример работы итератора с обычным, отрицательным, и двойным шагом:

Заполнение соответствия и получение списка его ключей для получения списка уникальных значений массива. Ничего сверхестественного, просто сахар.

// Получение уникальных значений массива
УникальныеЗначения = Обработки.УниверсальнаяКоллекция_бук.Создать();
УникальныеЗначения.Инициализировать("Соответствие");
Для Каждого ТекЗначение Из ВходящийМассив Цикл
   УникальныеЗначения.Вставить(ТекЗначение, Истина);
КонецЦикла;
    
Результат = УникальныеЗначения.ВыгрузитьКлючи();

Предположим, что вместо массива может быть любая другая коллекция (кроме Таблиц) и алгоритм станет больше лишь на пару строк:

// Получение уникальных значений коллекции (Массив,СписокЗначений,Структура,Соответствие, фикс. коллекции)
КоллекцияДанных = Обработки.УниверсальнаяКоллекция_бук.Создать();
КоллекцияДанных.Инициализировать(ВходящиеДанные);       
УникальныеЗначения = Обработки.УниверсальнаяКоллекция_бук.Создать();
УникальныеЗначения.Инициализировать("Соответствие");
Пока КоллекцияДанных.Следующий() Цикл
   УникальныеЗначения.Вставить(КоллекцияДанных.Значение(), Истина);
КонецЦикла;
    
Результат = УникальныеЗначения.ВыгрузитьКлючи();

Данные для тестирования. Массив размером 10 000
Типовой поиск. Найти(): 200 значений: 17 мс.

Тестирование СписокЗначений
СписокЗначений.Класс. Поиск по значению (аналог типового). 200 элементов: 41 мс.
СписокЗначений.Класс. Поиск всех элементов по значению. 200 значений: 2 476 мс.
СписокЗначений.Класс. Индексирование. 10 000 элементов: 203 мс.
СписокЗначений.Класс. Поиск по значению с индексом. 200 значений: 2 мс.
СписокЗначений.Класс. Поиск всех элементов по значению с индексом. 200 значений: 3 мс.
Тестирование Соответствие
Соответствие.Класс. Поиск по значению (аналог типового). 200 элементов: 1 931 мс.
Соответствие.Класс. Поиск всех элементов по значению. 200 значений: 3 560 мс.
Соответствие.Класс. Индексирование. 10 000 элементов: 220 мс.
Соответствие.Класс. Поиск по значению с индексом. 200 значений: 2 мс.
Соответствие.Класс. Поиск всех элементов по значению с индексом. 200 значений: 3 мс.
Тестирование Структура
Структура.Класс. Поиск по значению (аналог типового). 200 элементов: 1 894 мс.
Структура.Класс. Поиск всех элементов по значению. 200 значений: 3 435 мс.
Структура.Класс. Индексирование. 10 000 элементов: 202 мс.
Структура.Класс. Поиск по значению с индексом. 200 значений: 2 мс.
Структура.Класс. Поиск всех элементов по значению с индексом. 200 значений: 2 мс.
Тестирование Массив
Массив.Класс. Поиск по значению (аналог типового). 200 элементов: 44 мс.
Массив.Класс. Поиск всех элементов по значению. 200 значений: 1 996 мс.
Массив.Класс. Индексирование. 10 000 элементов: 188 мс.
Массив.Класс. Поиск по значению с индексом. 200 значений: 3 мс.
Массив.Класс. Поиск всех элементов по значению с индексом. 200 значений: 3 мс. 

 Общие требования:

Должен быть доступен на сервере, внешнем соединении, на толстых клиентах, на тонком и веб клиентах.

Нет копипаста кода - для облегчения сопровождения.

Логическая реализация

Реализован общий родительский класс содержащий только статические методы

Реализовано два дочерних класса.

Иерархическая структура класса УниверсальнаяКоллекция:

• УниверсальнаяКоллекция - родительский. Не создаёт экземпляры, доступны только статические методы
  • УниверсальнаяКоллекцияСервер - дочерний класс. Для работы на сервере и в толстых клиентах.
  • УниверсальнаяКоллекцияКлиент - дочерний класс. Для работы в тонких клиентах. Менее производительный.

Инициализация производится через единый интерфейс. В зависимости от контекста инициализируется один из двух дочерних классов.

ЭкземплярКласса = КоллекцииКлиентСервер_бук.ЭкземплярКлассаУниверсальнаяКоллекция("Массив");

Также, проектируется еще два дочерних класса.

ТаблицаЗначений - проектируемый дочерний класс для работы с таблицами значений.
Таблицы - проектируемый дочерний класс для работы с разнообразными таблицами во всех контекстах включая: ТаблицаЗначений, ТаблицаФормы, ДинамичесийСписок и.т.д.

По завершению работ, будут выпущены отдельные поставки в дополнение к существующим:

Полная - вся функциональность.

Обновление с поставки "Универсальная коллекция".