File: ListInterface.pm

package info (click to toggle)
grid-packaging-tools 3.6.2-1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 1,936 kB
  • sloc: perl: 15,766; sh: 3,032; makefile: 225
file content (203 lines) | stat: -rw-r--r-- 3,195 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
package Grid::GPT::PackageFilelist::xml1::ListInterface;

$VERSION = 1.00;

use strict;
use vars qw( $AUTOLOAD @ISA @EXPORT ); # Keep 'use strict' happy
use Carp;

require Exporter;
require AutoLoader;
require Grid::GPT::GPTObject;

@ISA = qw(Exporter AutoLoader Grid::GPT::GPTObject);
# Items to export into callers namespace by default. Note: do not export
# names by default without a very good reason. Use EXPORT_OK instead.
# Do not simply export all your public functions/methods/constants.
@EXPORT = qw(
);

#
# include standard modules
#

require Grid::GPT::PackageFile;

#
# data internal to the class
#

my $_count = 0;

#
# Class methods
#

sub get_count
{
    $_count;
}

sub _incr_count { ++$_count }
sub _decr_count { --$_count }

### new( $caller, %args )
#
# Object Constructor
#

sub new
{
    my $caller = shift;
    my(%args) = @_;
    my $caller_is_obj = ref($caller);
    my $class = $caller_is_obj || $caller;

    #
    # bless $self and up the ref count
    #

    my $self = bless {}, $class;

    if ( scalar(@_) == 0 )
    {
        $self->_incr_count();
        return $self;
    }

    #
    # handle arguments
    #
 
    my (
         $packageList,
       ) = (
         $args{'packageList'},
       );

    #
    # store the packageList object
    #

    if (!defined($packageList))
    {
        die("ERROR: package list is undefined");
    }

    $self->{'packageList'} = $packageList;

    #
    # increment refcount
    #

    $self->_incr_count();

    return $self;
}

sub DESTROY
{
    $_[0]->_decr_count();
}

sub AUTOLOAD
{
}

END { }

#
# Standard methods
#

### addFile( file => $file )
#
# add file to the package's filelist
#

sub addFile
{
    my($self, %args) = @_;

    #
    # handle arguments
    #

    my $file = $args{'file'};

    if ( !defined($file) )
    {
        die("ERROR: file object in package list is undefined");
    }

    $self->{'packageList'}->addFile( file => $file );

    return 1;
}

### getList( )
#
# return a reference to an array that contains all of the files in the
# current filelist
#

sub getList
{
    my($self, %args) = @_;

    #
    # for each of the entries in our filelist, get the path and add it to our list
    #

    my $filelist = $self->{'packageList'}->getFilelist();

    return $filelist;
}

sub isEmpty
{
    my($self, %args) = @_;

    #
    # pull our filelist array into our scope
    #

    my $filelist = $self->{'packageList'}->getFilelist();

    if ( scalar(@$filelist) eq 0 )
    {
        return 1;
    }
    else
    {
        return 0;
    }
}

1; # Ensure that the module can be successfully use'd

__END__

=head1 NAME

Grid::GPT::PackageFilelist::xml1::ListInterface - Perl extension for List operations for xml1 filelists

=head1 SYNOPSIS

  use Grid::GPT::PackageFilelist::xml1::ListInterface;
  my $io = new Grid::GPT::PackageFilelist::xml1::ListInterface();

=head1 DESCRIPTION

I<Grid::GPT::PackageFilelist::xml1::ListInterface> handles adding to and reading
from the PackageFilelist::List object when necessary.

=head1 AUTHOR

Chase Phillips <cphillip@ncsa.uiuc.edu>

=head1 SEE ALSO

perl(1) Grid::GPT::PackageFilelist::xml1(1) Grid::GPT::PackageFilelist::xml1::IO(1)

=cut