Skip to content

Latest commit

 

History

History
90 lines (72 loc) · 4.44 KB

FunctionalView.md

File metadata and controls

90 lines (72 loc) · 4.44 KB

Definitions, Acronyms, Abbreviations

# Abbreviation or Acronym Definition
1 CLT Command Line Task
2 Dictionary A dictionary is a general-purpose data structure for storing a group of objects. A dictionary has a set of keys and each key has a single associated value. When presented with a key, the dictionary will return the associated value.
3 Multimedia data Multimedia in principle means data of more than one medium. It usually refers to data representing multiple types of medium to capture information and experiences related to objects and events. Commonly used forms of data are numbers, alphanumeric, text, images, audio, and video. In common usage, people refer a data set as multimedia only when time-dependent data such as audio and video are involved.
4 metadata Metadata is "data that provides information about other data". In other words, it is "data about data." Many distinct types of metadata exist, including descriptive metadata, structural metadata, administrative metadata, reference metadata and statistical metadata.
5 SOA Service-oriented architecture (SOA) is an architectural style that supports service orientation. By consequence, it is as well applied in the field of software design where services are provided to the other components by application components, through a communication protocol over a network.

Layers

TBD - describe why layered arch and why not SOA

(UI)layer

The photo album owner interacts with the system through the user interface (UI) layer components. Basing on flow and user needs, UI interacts with other components described later.

graph TD
    A(UI) --> B(Configurator)
    A(UI) --> C(Description Editor)
    A(UI) --> D(Dictionary Editor)
    A(UI) --> E(Player)
    A(UI) --> F(Viewer)
    A(UI) --> G(Organizer Wizard)
Loading

Configurator

The main function of the Configurator is to provide the settings to other components when requested and to save/load them to/from data layer. Configurator works directly with saved in the disk settings. Instead, it uses FvaConfiguration.

Description Editor

TBD

Dictionary Editor

TBD

Player

TBD

Viewer

TBD

Organizer Wizard

TBD

Processing layer

graph TD
    A(Processing) --> B(Data Processor)
    A(Processing) --> C(Flow Controller)
    A(Processing) --> D(Organizer)
Loading

The purpose of Flow Controller is to manage the action flows between UI and the Data processor. The flows can be configured by the Configurator component.

Data Processor performs such actions as checking the multimedia Metadata for presence and consistency and enriching it.

Organizer makes possible to start any command in separate process from command line or in separate thread.

Data layer

graph TD
    A(Data) --> B(Input Multimedia Data)
    A(Data) --> C(Output Multimedia Data)
    A(Data) --> D(FVA Software configuration)
    A(Data) --> E(FVA Software internal metadata)
    A(Data) --> F(FVA Software dictionary)
Loading

Input Multimedia Data

TBD

Output Multimedia Data

TBD

FVA Software configuration

TBD The formatting strings shall be kept in a separated category

FVA Software internal metadata

It is used to enrich Output Multimedia Data.

FVA Software dictionary

FVA Software dictionary is data used along with FVA Software internal metadata.

Logging

All the main components interact with the Logging component to log the important events during processing. During logging the logging component uses a "log level" setting got from FVAConfigurator. The log shall be present as a CSV file with name of component it was created by. The format of log file shall be following: TBD