annotate Lib/IMPL/DOM/Schema/ValidationError.pm @ 331:2ff1726c066c

removed operation contract (due it's useless)
author cin
date Wed, 05 Jun 2013 18:21:11 +0400
parents 4ddb27ff4a0b
children 2f16f13b000c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
49
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 24
diff changeset
1 package IMPL::DOM::Schema::ValidationError;
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 24
diff changeset
2 use strict;
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 24
diff changeset
3 use warnings;
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 24
diff changeset
4
104
196bf443b5e1 DOM::Schema RC0 inflators support, validation and some other things,
wizard
parents: 102
diff changeset
5 use overload
196bf443b5e1 DOM::Schema RC0 inflators support, validation and some other things,
wizard
parents: 102
diff changeset
6 '""' => \&toString,
196bf443b5e1 DOM::Schema RC0 inflators support, validation and some other things,
wizard
parents: 102
diff changeset
7 'fallback' => 1;
196bf443b5e1 DOM::Schema RC0 inflators support, validation and some other things,
wizard
parents: 102
diff changeset
8
165
76515373dac0 Added Class::Template,
wizard
parents: 125
diff changeset
9 use parent qw(IMPL::Object);
49
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 24
diff changeset
10 use IMPL::Class::Property;
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 24
diff changeset
11 use IMPL::Resources::Format qw(FormatMessage);
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 24
diff changeset
12
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 24
diff changeset
13 BEGIN {
236
2904da230022 DOM refactoring
sergey
parents: 230
diff changeset
14 public _direct property node => prop_get; # target document node (if exists)
2904da230022 DOM refactoring
sergey
parents: 230
diff changeset
15 public _direct property schema => prop_get; # a schema for the target node (if exists)
2904da230022 DOM refactoring
sergey
parents: 230
diff changeset
16 public _direct property source => prop_get; # a schema which triggered this error (can be equal to the Schema)
2904da230022 DOM refactoring
sergey
parents: 230
diff changeset
17 public _direct property parent => prop_get;
2904da230022 DOM refactoring
sergey
parents: 230
diff changeset
18 public _direct property message => prop_get; # displayable message
49
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 24
diff changeset
19 }
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 24
diff changeset
20
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 24
diff changeset
21 sub CTOR {
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 24
diff changeset
22 my ($this,%args) = @_;
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 24
diff changeset
23
236
2904da230022 DOM refactoring
sergey
parents: 230
diff changeset
24 $this->{$node} = $args{node};
2904da230022 DOM refactoring
sergey
parents: 230
diff changeset
25 $this->{$schema} = $args{schema} if $args{schema};
2904da230022 DOM refactoring
sergey
parents: 230
diff changeset
26 $this->{$source} = $args{source} if $args{source};
2904da230022 DOM refactoring
sergey
parents: 230
diff changeset
27 if ($args{parent}) {
2904da230022 DOM refactoring
sergey
parents: 230
diff changeset
28 $this->{$parent} = $args{parent};
2904da230022 DOM refactoring
sergey
parents: 230
diff changeset
29 } elsif ($args{node}) {
2904da230022 DOM refactoring
sergey
parents: 230
diff changeset
30 $this->{$parent} = $args{node}->parentNode;
125
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
31 } else {
236
2904da230022 DOM refactoring
sergey
parents: 230
diff changeset
32 die new IMPL::InvalidArgumentException("A 'parent' or a 'node' parameter is required");
125
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
33 }
236
2904da230022 DOM refactoring
sergey
parents: 230
diff changeset
34 $this->{$message} = FormatMessage(delete $args{message}, \%args) if $args{message};
49
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 24
diff changeset
35 }
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 24
diff changeset
36
104
196bf443b5e1 DOM::Schema RC0 inflators support, validation and some other things,
wizard
parents: 102
diff changeset
37 sub toString {
194
4d0e1962161c Replaced tabs with spaces
cin
parents: 180
diff changeset
38 (my $this) = @_;
236
2904da230022 DOM refactoring
sergey
parents: 230
diff changeset
39 return $this->message;
104
196bf443b5e1 DOM::Schema RC0 inflators support, validation and some other things,
wizard
parents: 102
diff changeset
40 }
196bf443b5e1 DOM::Schema RC0 inflators support, validation and some other things,
wizard
parents: 102
diff changeset
41
49
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 24
diff changeset
42 1;
125
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
43
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
44 __END__
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
45
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
46 =pod
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
47
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
48 =head1 NAME
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
49
180
d1676be8afcc Перекодировка в utf-8
sourcer
parents: 165
diff changeset
50 C<IMPL::DOM::Schema::ValidationError> - Описывает ошибку в документе.
125
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
51
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
52 =head1 DESCRIPTION
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
53
180
d1676be8afcc Перекодировка в utf-8
sourcer
parents: 165
diff changeset
54 При проверке документа на ошибки формирования возвращается массив с объектами
d1676be8afcc Перекодировка в utf-8
sourcer
parents: 165
diff changeset
55 C<IMPL::DOM::Schema::ValidationError>, каждая из которых описывает одну ошибку
d1676be8afcc Перекодировка в utf-8
sourcer
parents: 165
diff changeset
56 в документе.
125
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
57
180
d1676be8afcc Перекодировка в utf-8
sourcer
parents: 165
diff changeset
58 С помощью данного объекта осущетсвляется привязка элемента схемы, элемента документа
d1676be8afcc Перекодировка в utf-8
sourcer
parents: 165
diff changeset
59 и сообщения о причине возникновения ошибки.
125
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
60
236
2904da230022 DOM refactoring
sergey
parents: 230
diff changeset
61 Часть ошибок, таких как проверка содержимого на регулярные выражения, привязаны
2904da230022 DOM refactoring
sergey
parents: 230
diff changeset
62 непосредственно к элементу. Но есть ошибки которые привязываются к родительскому
2904da230022 DOM refactoring
sergey
parents: 230
diff changeset
63 контейнеру, например отсутсвие обязательного элемента. В таком случае ошибка
2904da230022 DOM refactoring
sergey
parents: 230
diff changeset
64 содержит свойство C<parent> и по свойству C<source> можно определить элемент
2904da230022 DOM refactoring
sergey
parents: 230
diff changeset
65 (например его имя), к которому относится ошибка.
2904da230022 DOM refactoring
sergey
parents: 230
diff changeset
66
125
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
67 =head1 MEMBERS
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
68
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
69 =over
230
6d8092d8ce1b *reworked IMPL::Security
sergey
parents: 194
diff changeset
70
265
6b6d4b2275a1 improved documentation
cin
parents: 236
diff changeset
71 =item C<[get] node>
125
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
72
180
d1676be8afcc Перекодировка в utf-8
sourcer
parents: 165
diff changeset
73 Узел в документе который привел к ошибке. Как правило это либо простые узлы, либо
d1676be8afcc Перекодировка в utf-8
sourcer
parents: 165
diff changeset
74 узлы, которые не могут присутствоать в данном месте по схеме.
125
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
75
180
d1676be8afcc Перекодировка в utf-8
sourcer
parents: 165
diff changeset
76 Данное свойство может быть C<undef>.
125
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
77
265
6b6d4b2275a1 improved documentation
cin
parents: 236
diff changeset
78 =item C<[get] parent>
125
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
79
265
6b6d4b2275a1 improved documentation
cin
parents: 236
diff changeset
80 Родительский узел в котором произошла ошибка. Используется в случаях, когда C<node>
180
d1676be8afcc Перекодировка в utf-8
sourcer
parents: 165
diff changeset
81 не указан, например, если по схеме должен существовать дочерний узел с определенным
d1676be8afcc Перекодировка в utf-8
sourcer
parents: 165
diff changeset
82 именем, а в реальном документе его нет.
125
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
83
180
d1676be8afcc Перекодировка в utf-8
sourcer
parents: 165
diff changeset
84 Также это свойство может использоваться при формировании сообщения.
125
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
85
265
6b6d4b2275a1 improved documentation
cin
parents: 236
diff changeset
86 =item C<[get] schema>
125
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
87
180
d1676be8afcc Перекодировка в utf-8
sourcer
parents: 165
diff changeset
88 Схема для C<Node> или узла который должен присутсвовать если C<Node> не задан.
125
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
89
265
6b6d4b2275a1 improved documentation
cin
parents: 236
diff changeset
90 =item C<[get] source>
125
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
91
180
d1676be8afcc Перекодировка в utf-8
sourcer
parents: 165
diff changeset
92 Схема, проверка которой привела к возникновению ошибки. Поскольку схемы могут
d1676be8afcc Перекодировка в utf-8
sourcer
parents: 165
diff changeset
93 использовать ссылки, то данное свойство нужно для получения схемы узла, а не
d1676be8afcc Перекодировка в utf-8
sourcer
parents: 165
diff changeset
94 схемы его типа.
125
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
95
180
d1676be8afcc Перекодировка в utf-8
sourcer
parents: 165
diff changeset
96 Тоесть проверка схемы узла C<IMPL::DOM::Schema::Node> приводит к проверке схемы
d1676be8afcc Перекодировка в utf-8
sourcer
parents: 165
diff changeset
97 типа, например, C<IMPL::DOM::Schema::ComplexType>, а свойство C<Source> будет
d1676be8afcc Перекодировка в utf-8
sourcer
parents: 165
diff changeset
98 указывать именно на C<IMPL::DOM::Schema::Node>.
125
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
99
265
6b6d4b2275a1 improved documentation
cin
parents: 236
diff changeset
100 =item C<[get] message>
125
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
101
180
d1676be8afcc Перекодировка в utf-8
sourcer
parents: 165
diff changeset
102 Возвращает форматированное сообщение об ошибке.
125
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
103
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
104 =item C<toString()>
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
105
180
d1676be8afcc Перекодировка в utf-8
sourcer
parents: 165
diff changeset
106 Преобразует ошибку к строке, возвращает значение свойства C<Message>
125
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
107
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
108 =back
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
109
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
110 =head1 REMARKS
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
111
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
112 =begin code
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
113
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
114 my $doc = IMPL::DOM::XMLReader->LoadDocument('data.xml');
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
115 my $schema = IMPL::DOM::Schema->LoadSchema('schema.xml');
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
116
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
117 my @errors = $schema->Validate($doc);
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
118
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
119 my $node = $doc->selectSingleNode('user','name');
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
120
180
d1676be8afcc Перекодировка в utf-8
sourcer
parents: 165
diff changeset
121 # Получаем все ошибки относящиеся к данному узлу
265
6b6d4b2275a1 improved documentation
cin
parents: 236
diff changeset
122 my @nodeErrors = grep { ($_->node || $_->parent) == $node } @errors;
125
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
123
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
124 =end code
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
125
a4b0a819bbda Small fixes in IMPL::DOM::Schema
wizard
parents: 104
diff changeset
126 =cut