| 1 | #!/usr/bin/perl | ||
| 2 | ############################################################################### | ||
| 3 | # | ||
| 4 | # @brief Eulerian EDW Sql Timerange class definition. | ||
| 5 | # | ||
| 6 | # @file API/Eulerian/EDW/Sql/Timerange.pm | ||
| 7 | # | ||
| 8 | # @author x.thorillon@eulerian.com | ||
| 9 | # | ||
| 10 | ############################################################################### | ||
| 11 | # | ||
| 12 | # Enforce compilor rules. | ||
| 13 | # | ||
| 14 | use strict; use warnings; | ||
| 15 | # | ||
| 16 | # Setup Package path. | ||
| 17 | # | ||
| 18 | package API::Eulerian::EDW::Sql::Timerange; | ||
| 19 | # | ||
| 20 | # @brief Allocate and initialize a new Eulerian Data Warehouse Sql Timerange. | ||
| 21 | # | ||
| 22 | # @param $class - Class. | ||
| 23 | # @param $setup - Initial setup parameters. | ||
| 24 | # begin => Timerange begin. | ||
| 25 | # end => Timerange end. | ||
| 26 | # | ||
| 27 | # @return Timerange. | ||
| 28 | # | ||
| 29 | sub new | ||
| 30 | { | ||
| 31 | my $proto = shift; | ||
| 32 | my $class = ref( $proto ) || $proto; | ||
| 33 | my $setup = shift; | ||
| 34 | return bless( { | ||
| 35 | begin => $setup->{ begin } || undef, | ||
| 36 | end => $setup->{ end } || undef, | ||
| 37 | } | ||
| 38 | ); | ||
| 39 | } | ||
| 40 | # | ||
| 41 | # @brief Setup Timerange begin. | ||
| 42 | # | ||
| 43 | # @param $self - Sql Timerange. | ||
| 44 | # @param $begin - Timerange begin. | ||
| 45 | # | ||
| 46 | # @return Timerange begin. | ||
| 47 | # | ||
| 48 | sub begin | ||
| 49 | { | ||
| 50 | my ( $self, $begin ) = @_; | ||
| 51 | |||
| 52 | if( defined( $begin ) ) { | ||
| 53 | $self->{ begin } = $begin; | ||
| 54 | } else { | ||
| 55 | $begin = $self->{ begin }; | ||
| 56 | } | ||
| 57 | |||
| 58 | return $begin; | ||
| 59 | } | ||
| 60 | # | ||
| 61 | # @brief Setup Timerange end. | ||
| 62 | # | ||
| 63 | # @param $self - Sql Timerange. | ||
| 64 | # @param $end - Timerange end. | ||
| 65 | # | ||
| 66 | # @return Timerange end. | ||
| 67 | # | ||
| 68 | sub end | ||
| 69 | { | ||
| 70 | my ( $self, $end ) = @_; | ||
| 71 | |||
| 72 | if( defined( $end ) ) { | ||
| 73 | $self->{ end } = $end; | ||
| 74 | } else { | ||
| 75 | $end = $self->{ end }; | ||
| 76 | } | ||
| 77 | |||
| 78 | return $end; | ||
| 79 | } | ||
| 80 | # | ||
| 81 | # @brief Test if timerange is valid. | ||
| 82 | # | ||
| 83 | # @param $self - Self. | ||
| 84 | # | ||
| 85 | # @return 1 - Valid. | ||
| 86 | # @return 0 - Invalid. | ||
| 87 | # | ||
| 88 | sub valid | ||
| 89 | { | ||
| 90 | my $self = shift; | ||
| 91 | return 1; | ||
| 92 | } | ||
| 93 | # | ||
| 94 | # @brief Stringify Eulerian Data Warehouse Sql Timerange. | ||
| 95 | # | ||
| 96 | # @param $self - Self. | ||
| 97 | # | ||
| 98 | # @return Stringified timerange. | ||
| 99 | # | ||
| 100 | sub str | ||
| 101 | { | ||
| 102 | my ( $self ) = @_; | ||
| 103 | my $string = ''; | ||
| 104 | $string .= "TIMERANGE{ "; | ||
| 105 | $string .= $self->{ begin }; | ||
| 106 | $string .= ", "; | ||
| 107 | $string .= $self->{ end }; | ||
| 108 | $string .= " }"; | ||
| 109 | return $string; | ||
| 110 | } | ||
| 111 | |||
| 112 | 1; | ||
| 113 | |||
| 114 | __END__ |