| 1 | #/usr/bin/env perl | ||
| 2 | ############################################################################### | ||
| 3 | # | ||
| 4 | # @file Parser.pm | ||
| 5 | # | ||
| 6 | # @brief Eulerian Data Warehouse REST Parser Module definition. | ||
| 7 | # | ||
| 8 | # This module is the base class of every input file parser. | ||
| 9 | # | ||
| 10 | # @author Thorillon Xavier:x.thorillon@eulerian.com | ||
| 11 | # | ||
| 12 | # @date 26/11/2021 | ||
| 13 | # | ||
| 14 | # @version 1.0 | ||
| 15 | # | ||
| 16 | ############################################################################### | ||
| 17 | # | ||
| 18 | # Setup module name | ||
| 19 | # | ||
| 20 | package API::Eulerian::EDW::Parser; | ||
| 21 | # | ||
| 22 | # Enforce compilor rules | ||
| 23 | # | ||
| 24 | use strict; use warnings; | ||
| 25 | # | ||
| 26 | # @brief Allocate and initialize a new API::Eulerian::EDW::Parser instance. | ||
| 27 | # | ||
| 28 | # @param $class - API::Eulerian::EDW::Parser class. | ||
| 29 | # @param $path - Input file path. | ||
| 30 | # @param $uuid - Eulerian Data Warehouse Analysis UUID. | ||
| 31 | # | ||
| 32 | # @return API::Eulerian::EDW::Parser instance. | ||
| 33 | # | ||
| 34 | sub new | ||
| 35 | { | ||
| 36 | my ( $class, $path, $uuid ) = @_; | ||
| 37 | return bless( { | ||
| 38 | _PATH => $path, | ||
| 39 | _UUID => $uuid, | ||
| 40 | }, $class ); | ||
| 41 | } | ||
| 42 | # | ||
| 43 | # @brief Get/Set Eulerian Data Warehouse Analysis UUID. | ||
| 44 | # | ||
| 45 | # @param $self - API::Eulerian::EDW::Parser instance. | ||
| 46 | # @param $uuid - Eulerian Data Warehouse Analysis UUID. | ||
| 47 | # | ||
| 48 | # @return Eulerian Data Warehouse Analysis UUID. | ||
| 49 | # | ||
| 50 | sub uuid | ||
| 51 | { | ||
| 52 | my ( $self, $uuid ) = @_; | ||
| 53 | $self->{ _UUID } = $uuid if $uuid; | ||
| 54 | return $self->{ _UUID }; | ||
| 55 | } | ||
| 56 | # | ||
| 57 | # @brief Get/Set Input file path. | ||
| 58 | # | ||
| 59 | # @parm $self - API::Eulerian::EDW::Parser instance. | ||
| 60 | # | ||
| 61 | # @return Input file path. | ||
| 62 | # | ||
| 63 | sub path | ||
| 64 | { | ||
| 65 | my ( $self, $path ) = @_; | ||
| 66 | $self->{ _PATH } = $path if $path; | ||
| 67 | return $self->{ _PATH }; | ||
| 68 | } | ||
| 69 | # | ||
| 70 | # @brief Parse input file path and call user specific hook. | ||
| 71 | # | ||
| 72 | # @param $self - API::Eulerian::EDW::Parser instance. | ||
| 73 | # @param $hook - API::Eulerian::EDW::Hook instance. | ||
| 74 | # | ||
| 75 | sub do {} | ||
| 76 | # | ||
| 77 | # Endup module properly | ||
| 78 | # | ||
| 79 | 1; | ||
| 80 | |||
| 81 | __END__ |