# Copyright (c) 2001 bivio Software, Inc.  All rights reserved.
#
# Visit http://www.bivio.biz for more info.
# 
# This library is free software; you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as
# published by the Free Software Foundation; either version 2.1 of the
# License, or (at your option) any later version.
# 
# This library is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
# 
# You should have received a copy of the GNU Lesser General Public
# License along with this library;  If not, you may get a copy from:
# http://www.opensource.org/licenses/lgpl-license.html
# 
# $Id: LocalFileType.pm,v 2.3 2007/01/19 05:28:59 aviggio Exp $
package Bivio::UI::LocalFileType;
use strict;
$Bivio::UI::LocalFileType::VERSION = sprintf('%d.%02d', q$Revision: 2.3 $ =~ /\d+/g);
$_ = $Bivio::UI::LocalFileType::VERSION;

=head1 NAME

Bivio::UI::LocalFileType - identifies local file trees

=head1 RELEASE SCOPE

bOP

=head1 SYNOPSIS

    use Bivio::UI::LocalFileType;

=cut

=head1 EXTENDS

L<Bivio::Type::Enum>

=cut

use Bivio::Type::Enum;
@Bivio::UI::LocalFileType::ISA = ('Bivio::Type::Enum');

=head1 DESCRIPTION

C<Bivio::UI::LocalFileType> identifies local file trees used within
a Facade.  See
L<Bivio::UI::Facade::get_local_file_name|Bivio::UI::Facade/"get_local_file_name">
for more details.

The following values are defined:

=over 4

=item PLAIN

Tree of all ordinary files to be returned to the user by name, e.g.  icons and
plain html.  No translation is performed.

=item VIEW

L<Bivio::UI::View|Bivio::UI::View> loads views from this tree.

=item CACHE

B<DEPRECATED>.  Denormalized files which can be rebuilt.

=item REALM_DATA

B<DEPRECATED>.  Files by realm.

=item DDL

SQL files to create database

=back

=cut

#=IMPORTS

#=VARIABLES
__PACKAGE__->compile([
    PLAIN => [
    	1,
	'plain/',
    ],
    VIEW => [
	2,
	'view/',
    ],
    CACHE => [
        3,
        'cache/',
    ],
    REALM_DATA => [
        4,
        'realm-data/',
    ],
    DDL => [
	5,
	'ddl/',
    ],
]);

=head1 METHODS

=cut

=for html <a name="get_path"></a>

=head2 get_path() : string

Returns the path to be used to find this area from the local_file_root.
Always ends in a trailing slash.

=cut

sub get_path {
    return shift->get_short_desc;
}

#=PRIVATE METHODS

=head1 COPYRIGHT

Copyright (c) 2001 bivio Software, Inc.  All rights reserved.

Visit http://www.bivio.biz for more info.

This library is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as
published by the Free Software Foundation; either version 2.1 of the
License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library;  If not, you may get a copy from:
http://www.opensource.org/licenses/lgpl-license.html

=head1 VERSION

$Id: LocalFileType.pm,v 2.3 2007/01/19 05:28:59 aviggio Exp $

=cut

1;