Source code for timApp.timdb.icons

"""
The module contains the database functions related to icons that are used in velps and annotations.
Icons are be retrieved from the database through this module. The module is not yet used in production.

:authors: Joonas Lattu, Petteri Palojärvi
:copyright: 2016 Timber project members
:version: 1.0.0

"""

from sqlite3 import Connection
from timdb.timdbbase import TimDbBase,TimDbException


class Icons(TimDbBase):
    def __init__(self, db_path: Connection, files_root_path: str, type_name: str, current_user_name: str):
        """Initializes TimDB with the specified database and root path.

        :param type_name: The type name.
        :param current_user_name: The name of the current user.
        :param db_path: The path of the database file.
        :param files_root_path: The root path where all the files will be stored.
        """
        TimDbBase.__init__(self, db_path, files_root_path, type_name, current_user_name)

    def get_file_name(self,icon_id: int) -> str:
        """Retrieves the filename for the icon.

        :param icon_id: The id of the icon.
        :return: A filename for the icon.
        """
        cursor=self.db.cursor()
        cursor.execute('SELECT filename FROM Icon WHERE id=?',icon_id)
        results=cursor.fetchall()
        if not results:
            raise TimDbException('No icon with id '+icon_id+' found.')
        filename=results.pop()
        return filename