File Coverage

blib/lib/xDT/RecordType.pm

Criterion	Covered	Total	%
statement	3	5	60.0
branch			n/a
condition			n/a
subroutine	2	2	100.0
pod			n/a
total	5	7	71.4

package xDT::RecordType;

use v5.10;
use Moose;
use namespace::autoclean;
use Carp;
use XML::Simple;
use File::Basename;

=head1 NAME

xDT::RecordType - The record type of a xDT record.

=head1 VERSION

Version 1.00

=cut

our $VERSION = '1.00';


=head1 SYNOPSIS

Quick summary of what the module does.

Perhaps a little code snippet.

    use xDT::RecordType;

    my $foo = xDT::RecordType->new();
    ...

=head1 EXPORT

A list of functions that can be exported.  You can delete this section
if you don't export anything, such as for a purely object-oriented module.

=head1 CONSTANTS

=head2 LENGTH
The maximum length of a record type identifier.
=cut

use constant {
	LENGTH => 4,

};

=head1 ATTRIBUTES

=head2 id
Unique identifier of this record type.
=cut

has id => (
	is            => 'ro',
	isa           => 'Str',
	required      => 1,
	reader        => 'getId',
	trigger       => \&_checkId,
	documentation => 'Unique identifier of this record type.',
);

=head2 labels
The human readable labels of this record type. Language is used as key value.
=cut

has labels => (
	is            => 'ro',
	isa           => 'Maybe[HashRef[Str]]',
	reader        => 'getLabels',
	documentation => 'The human readable labels of this record type. Language is used as key value.',
);

=head2 accessor
Short string for easy access to this record via xDT::Object.
=cut

has accessor => (
	is            => 'ro',
	isa           => 'Str',
	required      => 1,
	reader        => 'getAccessor',
	documentation => 'Short string for easy access to this record via xDT::Object.',
);

=head2 length
Max length of this record type.
=cut

has length => (
	is            => 'ro',
	isa           => 'Maybe[Str]',
	reader        => 'getLength',
	documentation => 'Max length of this record type.',
);

=head2 type
Corresponds to xDT record type string.
=cut

has type => (
	is            => 'ro',
	isa           => 'Maybe[Str]',
	reader        => 'getType',
	documentation => 'Corresponds to xDT record type string.'
);

around BUILDARGS => sub {
	my $orig  = shift;
	my $class = shift;

	if (@_ == 1 && !ref $_[0]) {
		return $class->$orig(_extractParametersFromConfigFile($_[0]));
	} else {
		my %params = @_;
		return $class->$orig(_extractParametersFromConfigFile($params{'id'}));
	}
};

=head1 SUBROUTINES/METHODS

=head2 isObjectEnd
Checks if this record type is an ending record
=cut

sub isObjectEnd {
	my $self = shift;

	return $self->getId == 8201;
}

=head2 getId
Returns the id of this record type.
=cut

=head2 getLabels
Returns the labels of this record type.
=cut

=head2 getAccessor
Returns the accessor of this record type.
=cut

=head2 getLength
Returns the maximum length of this recourd type.
=cut

=head2 getType
Returns the type of this record type.
=cut

sub _extractParametersFromConfigFile {
	my $id = shift // croak('Error: parameter $id missing.');

	my $xml = new XML::Simple(
		KeyAttr    => { RecordType => 'id', label => 'lang' },
		ForceArray => 1,
		ContentKey => '-content',
	);
	my $config = $xml->XMLin(File::Basename::dirname(__FILE__). '/Configuration/RecordTypes.xml')
		->{RecordType}->{$id};

	return (
		id       => $id,
		labels   => $config->{label},
		type     => $config->{type},
		accessor => $config->{accessor} // $id,
		length   => $config->{length},
	);
}


sub _checkId {
	my ($self, $id) = @_;

	croak(sprintf("Error: attribute 'id' has length %d (should be %d).", length $id, LENGTH))
		unless (length $id == LENGTH);
}

=head1 AUTHOR

Christoph Beger, C<<  >>

=head1 BUGS

Please report any bugs or feature requests to C, or through
the web interface at L.  I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.




=head1 SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc xDT::RecordType


You can also look for information at:

=over 4

=item * RT: CPAN's request tracker (report bugs here)

L

=item * AnnoCPAN: Annotated CPAN documentation

L

=item * CPAN Ratings

L

=item * Search CPAN

L

=back


=head1 ACKNOWLEDGEMENTS


=head1 LICENSE AND COPYRIGHT

Copyright 2017 Christoph Beger.

This program is released under the following license: MIT


=cut

__PACKAGE__->meta->make_immutable;

1; # End of xDT::RecordType