annotate Lib/IMPL/DOM/Document.pm @ 322:cca158327c47

added OutOfRangeException
author cin
date Tue, 21 May 2013 10:04:11 +0400
parents 77df11605d3a
children 010ceafd0c5a
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: 37
diff changeset
1 package IMPL::DOM::Document;
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
2 use strict;
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
3 use warnings;
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
4
280
c6d0f889ef87 +IMPL::declare now supports meta attributes
cin
parents: 194
diff changeset
5 use IMPL::lang;
315
77df11605d3a code cleanup
cin
parents: 280
diff changeset
6 use IMPL::declare {
77df11605d3a code cleanup
cin
parents: 280
diff changeset
7 require => {
77df11605d3a code cleanup
cin
parents: 280
diff changeset
8 DOMNode => 'IMPL::DOM::Node'
77df11605d3a code cleanup
cin
parents: 280
diff changeset
9 },
77df11605d3a code cleanup
cin
parents: 280
diff changeset
10 base => [
77df11605d3a code cleanup
cin
parents: 280
diff changeset
11 DOMNode => '@_'
77df11605d3a code cleanup
cin
parents: 280
diff changeset
12 ]
77df11605d3a code cleanup
cin
parents: 280
diff changeset
13 };
49
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
14
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
15 sub document {
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
16 return $_[0];
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
17 }
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
18
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
19 sub Create {
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
20 my ($this,$nodeName,$class,$refProps) = @_;
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
21
148
e6447ad85cb4 DOM objects now have a schema and schemaSource properties
wizard
parents: 104
diff changeset
22 if ( ref $class eq 'HASH' ) {
194
4d0e1962161c Replaced tabs with spaces
cin
parents: 180
diff changeset
23 $refProps = $class;
4d0e1962161c Replaced tabs with spaces
cin
parents: 180
diff changeset
24 $class = undef;
148
e6447ad85cb4 DOM objects now have a schema and schemaSource properties
wizard
parents: 104
diff changeset
25 }
e6447ad85cb4 DOM objects now have a schema and schemaSource properties
wizard
parents: 104
diff changeset
26
315
77df11605d3a code cleanup
cin
parents: 280
diff changeset
27 $class ||= DOMNode;
49
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
28 $refProps ||= {};
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
29
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
30 delete $refProps->{nodeName};
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
31
104
196bf443b5e1 DOM::Schema RC0 inflators support, validation and some other things,
wizard
parents: 77
diff changeset
32 die new IMPL::Exception("class is not specified") unless $class;
49
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
33 return $class->new(
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
34 nodeName => $nodeName,
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
35 document => $this,
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
36 %$refProps
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
37 );
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
38 }
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
39
152
1e7f03414b65 DOM: schema improvements
wizard
parents: 148
diff changeset
40 sub save {
194
4d0e1962161c Replaced tabs with spaces
cin
parents: 180
diff changeset
41 my ($this,$writer) = @_;
4d0e1962161c Replaced tabs with spaces
cin
parents: 180
diff changeset
42
4d0e1962161c Replaced tabs with spaces
cin
parents: 180
diff changeset
43 $writer->xmlDecl(undef,'yes');
4d0e1962161c Replaced tabs with spaces
cin
parents: 180
diff changeset
44 $this->SUPER::save($writer);
4d0e1962161c Replaced tabs with spaces
cin
parents: 180
diff changeset
45 $writer->end();
152
1e7f03414b65 DOM: schema improvements
wizard
parents: 148
diff changeset
46 }
1e7f03414b65 DOM: schema improvements
wizard
parents: 148
diff changeset
47
49
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
48 {
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
49 my $empty;
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
50 sub Empty() {
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
51 return $empty ? $empty : $empty = __PACKAGE__->new(nodeName => 'Empty');
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
52 }
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
53 }
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
54
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
55 1;
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
56 __END__
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
57
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
58 =pod
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
59
77
9d24db321029 Refactoring Web::TT
wizard
parents: 49
diff changeset
60 =head1 NAME
9d24db321029 Refactoring Web::TT
wizard
parents: 49
diff changeset
61
180
d1676be8afcc Перекодировка в utf-8
sourcer
parents: 165
diff changeset
62 C<IMPL::DOM::Document> DOM документ.
77
9d24db321029 Refactoring Web::TT
wizard
parents: 49
diff changeset
63
49
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
64 =head1 DESCRIPTION
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
65
180
d1676be8afcc Перекодировка в utf-8
sourcer
parents: 165
diff changeset
66 Документ, позволяет создавать узлы определенных типов, что позволяет абстрагироваться
d1676be8afcc Перекодировка в utf-8
sourcer
parents: 165
diff changeset
67 от механизмов реального создания объектов. Т.о. например C<IMPL::DOM::Navigator::Builder>
d1676be8afcc Перекодировка в utf-8
sourcer
parents: 165
diff changeset
68 может формировать произвольные документы.
77
9d24db321029 Refactoring Web::TT
wizard
parents: 49
diff changeset
69
9d24db321029 Refactoring Web::TT
wizard
parents: 49
diff changeset
70 =head1 SYNOPSIS
9d24db321029 Refactoring Web::TT
wizard
parents: 49
diff changeset
71
9d24db321029 Refactoring Web::TT
wizard
parents: 49
diff changeset
72 =begin code
9d24db321029 Refactoring Web::TT
wizard
parents: 49
diff changeset
73
9d24db321029 Refactoring Web::TT
wizard
parents: 49
diff changeset
74 package MyDocument;
165
76515373dac0 Added Class::Template,
wizard
parents: 152
diff changeset
75 use parent qw(IMPL::DOM::Document);
77
9d24db321029 Refactoring Web::TT
wizard
parents: 49
diff changeset
76
9d24db321029 Refactoring Web::TT
wizard
parents: 49
diff changeset
77 sub Create {
194
4d0e1962161c Replaced tabs with spaces
cin
parents: 180
diff changeset
78 my $this = shift;
4d0e1962161c Replaced tabs with spaces
cin
parents: 180
diff changeset
79 my ($name,$class,$hashProps) = @_;
4d0e1962161c Replaced tabs with spaces
cin
parents: 180
diff changeset
80
4d0e1962161c Replaced tabs with spaces
cin
parents: 180
diff changeset
81 if ($class eq 'Info') {
4d0e1962161c Replaced tabs with spaces
cin
parents: 180
diff changeset
82 return MyInfo->new($name,$hashProps->{date},$hashProps->{description});
4d0e1962161c Replaced tabs with spaces
cin
parents: 180
diff changeset
83 } else {
4d0e1962161c Replaced tabs with spaces
cin
parents: 180
diff changeset
84 # leave as it is
4d0e1962161c Replaced tabs with spaces
cin
parents: 180
diff changeset
85 return $this->SUPER::Create(@_);
4d0e1962161c Replaced tabs with spaces
cin
parents: 180
diff changeset
86 }
77
9d24db321029 Refactoring Web::TT
wizard
parents: 49
diff changeset
87 }
9d24db321029 Refactoring Web::TT
wizard
parents: 49
diff changeset
88
9d24db321029 Refactoring Web::TT
wizard
parents: 49
diff changeset
89 =end code
9d24db321029 Refactoring Web::TT
wizard
parents: 49
diff changeset
90
49
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
91 =head1 METHODS
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
92
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
93 =over
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
94
77
9d24db321029 Refactoring Web::TT
wizard
parents: 49
diff changeset
95 =item C< Create($nodeName,$class,$hashProps) >
9d24db321029 Refactoring Web::TT
wizard
parents: 49
diff changeset
96
180
d1676be8afcc Перекодировка в utf-8
sourcer
parents: 165
diff changeset
97 Реализация по умолчанию. Создает узел определеннго типа с определенным именем и свойствами.
77
9d24db321029 Refactoring Web::TT
wizard
parents: 49
diff changeset
98
9d24db321029 Refactoring Web::TT
wizard
parents: 49
diff changeset
99 =begin code
49
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
100
77
9d24db321029 Refactoring Web::TT
wizard
parents: 49
diff changeset
101 sub Create {
194
4d0e1962161c Replaced tabs with spaces
cin
parents: 180
diff changeset
102 my ($this,$nodeName,$class,$hashProps) = @_;
4d0e1962161c Replaced tabs with spaces
cin
parents: 180
diff changeset
103
4d0e1962161c Replaced tabs with spaces
cin
parents: 180
diff changeset
104 return $class->new (
4d0e1962161c Replaced tabs with spaces
cin
parents: 180
diff changeset
105 nodeName => $nodeName,
4d0e1962161c Replaced tabs with spaces
cin
parents: 180
diff changeset
106 document => $this,
4d0e1962161c Replaced tabs with spaces
cin
parents: 180
diff changeset
107 %$hashProps
4d0e1962161c Replaced tabs with spaces
cin
parents: 180
diff changeset
108 );
77
9d24db321029 Refactoring Web::TT
wizard
parents: 49
diff changeset
109 }
9d24db321029 Refactoring Web::TT
wizard
parents: 49
diff changeset
110
9d24db321029 Refactoring Web::TT
wizard
parents: 49
diff changeset
111 =end code
49
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
112
152
1e7f03414b65 DOM: schema improvements
wizard
parents: 148
diff changeset
113 =item C< save($writer) >
1e7f03414b65 DOM: schema improvements
wizard
parents: 148
diff changeset
114
180
d1676be8afcc Перекодировка в utf-8
sourcer
parents: 165
diff changeset
115 Сохраняет документ в виде XML узла и вызывает C<< $writer->end() >>.
152
1e7f03414b65 DOM: schema improvements
wizard
parents: 148
diff changeset
116
1e7f03414b65 DOM: schema improvements
wizard
parents: 148
diff changeset
117 =over
1e7f03414b65 DOM: schema improvements
wizard
parents: 148
diff changeset
118
1e7f03414b65 DOM: schema improvements
wizard
parents: 148
diff changeset
119 =item C<$writer>
1e7f03414b65 DOM: schema improvements
wizard
parents: 148
diff changeset
120
180
d1676be8afcc Перекодировка в utf-8
sourcer
parents: 165
diff changeset
121 Объект с интерфейсом C<XML::Writer> который будет использован для записи
d1676be8afcc Перекодировка в utf-8
sourcer
parents: 165
diff changeset
122 содержимого документа
152
1e7f03414b65 DOM: schema improvements
wizard
parents: 148
diff changeset
123
1e7f03414b65 DOM: schema improvements
wizard
parents: 148
diff changeset
124 =back
1e7f03414b65 DOM: schema improvements
wizard
parents: 148
diff changeset
125
49
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
126 =back
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
127
16ada169ca75 migrating to the Eclipse IDE
wizard@linux-odin.local
parents: 37
diff changeset
128 =cut