Skip to content

Commit f57b94a

Browse files
iluwatariluwatar
committed
Merge pull request iluwatar#433 from qza/master
Abstract Document
2 parents 34431d7 + afdeba4 commit f57b94a

File tree

19 files changed

+887
-2
lines changed

19 files changed

+887
-2
lines changed

‎abstract-document/README.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
layout: pattern
3+
title: Abstract Document
4+
folder: abstract-document
5+
permalink: /patterns/abstract-document/
6+
categories: Structural
7+
tags:
8+
- Java
9+
- Difficulty-Intermediate
10+
---
11+
12+
## Intent
13+
Achieve flexibility of untyped languages and keep the type-safety
14+
15+
![alt text](./etc/abstract-document-base.png "Abstract Document Base")
16+
17+
![alt text](./etc/abstract-document.png "Abstract Document Traits and Domain")
18+
19+
20+
## Applicability
21+
Use the Abstract Document Pattern when
22+
23+
* there is a need to add new properties on the fly
24+
* you want a flexible way to organize domain in tree like structure
25+
* you want more loosely coupled system
26+
27+
28+
## Credits
29+
30+
* [Wikipedia: Abstract Document Pattern](https://en.wikipedia.org/wiki/Abstract_Document_Pattern)
31+
* [Martin Fowler: Dealing with properties](http://martinfowler.com/apsupp/properties.pdf)

‎abstract-document/etc/abstract-document-base.png‎

14.6 KB
Loading

‎abstract-document/etc/abstract-document-base.ucls‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<class-diagram version="1.1.9" icons="true" automaticImage="PNG" always-add-relationships="false" generalizations="true"
3+
realizations="true" associations="true" dependencies="false" nesting-relationships="true" router="FAN">
4+
<interface id="1" language="java" name="com.iluwatar.abstractdocument.Document" project="design-patterns"
5+
file="/design-patterns/src/com/iluwatar/abstractdocument/Document.java" binary="false" corner="BOTTOM_RIGHT">
6+
<position height="-1" width="-1" x="249" y="405"/>
7+
<display autosize="true" stereotype="true" package="true" initial-value="false" signature="true"
8+
sort-features="false" accessors="true" visibility="true">
9+
<attributes public="true" package="true" protected="true" private="true" static="true"/>
10+
<operations public="true" package="true" protected="true" private="true" static="true"/>
11+
</display>
12+
</interface>
13+
<class id="2" language="java" name="com.iluwatar.abstractdocument.AbstractDocument" project="design-patterns"
14+
file="/design-patterns/src/com/iluwatar/abstractdocument/AbstractDocument.java" binary="false" corner="BOTTOM_RIGHT">
15+
<position height="-1" width="-1" x="250" y="237"/>
16+
<display autosize="true" stereotype="true" package="true" initial-value="false" signature="true"
17+
sort-features="false" accessors="true" visibility="true">
18+
<attributes public="true" package="true" protected="true" private="true" static="true"/>
19+
<operations public="true" package="true" protected="true" private="true" static="true"/>
20+
</display>
21+
</class>
22+
<class id="3" language="java" name="com.iluwatar.abstractdocument.domain.Car" project="design-patterns"
23+
file="/design-patterns/src/com/iluwatar/abstractdocument/domain/Car.java" binary="false" corner="BOTTOM_RIGHT">
24+
<position height="-1" width="-1" x="108" y="75"/>
25+
<display autosize="true" stereotype="true" package="true" initial-value="false" signature="true"
26+
sort-features="false" accessors="true" visibility="true">
27+
<attributes public="true" package="true" protected="true" private="true" static="true"/>
28+
<operations public="true" package="true" protected="true" private="true" static="true"/>
29+
</display>
30+
</class>
31+
<class id="4" language="java" name="com.iluwatar.abstractdocument.domain.Part" project="design-patterns"
32+
file="/design-patterns/src/com/iluwatar/abstractdocument/domain/Part.java" binary="false" corner="BOTTOM_RIGHT">
33+
<position height="-1" width="-1" x="400" y="76"/>
34+
<display autosize="true" stereotype="true" package="true" initial-value="false" signature="true"
35+
sort-features="false" accessors="true" visibility="true">
36+
<attributes public="true" package="true" protected="true" private="true" static="true"/>
37+
<operations public="true" package="true" protected="true" private="true" static="true"/>
38+
</display>
39+
</class>
40+
<generalization id="5">
41+
<end type="SOURCE" refId="4"/>
42+
<end type="TARGET" refId="2"/>
43+
</generalization>
44+
<realization id="6">
45+
<end type="SOURCE" refId="2"/>
46+
<end type="TARGET" refId="1"/>
47+
</realization>
48+
<generalization id="7">
49+
<end type="SOURCE" refId="3"/>
50+
<end type="TARGET" refId="2"/>
51+
</generalization>
52+
<classifier-display autosize="true" stereotype="true" package="true" initial-value="false" signature="true"
53+
sort-features="false" accessors="true" visibility="true">
54+
<attributes public="true" package="true" protected="true" private="true" static="true"/>
55+
<operations public="true" package="true" protected="true" private="true" static="true"/>
56+
</classifier-display>
57+
<association-display labels="true" multiplicity="true"/>
58+
</class-diagram>

‎abstract-document/etc/abstract-document.png‎

16.3 KB
Loading

‎abstract-document/etc/abstract-document.ucls‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<class-diagram version="1.1.9" icons="true" automaticImage="PNG" always-add-relationships="false" generalizations="true"
3+
realizations="true" associations="true" dependencies="false" nesting-relationships="true" router="FAN">
4+
<interface id="1" language="java" name="com.iluwatar.abstractdocument.Document" project="design-patterns"
5+
file="/design-patterns/src/com/iluwatar/abstractdocument/Document.java" binary="false" corner="BOTTOM_RIGHT">
6+
<position height="-1" width="-1" x="341" y="376"/>
7+
<display autosize="true" stereotype="true" package="true" initial-value="false" signature="true"
8+
sort-features="false" accessors="true" visibility="true">
9+
<attributes public="true" package="true" protected="true" private="true" static="true"/>
10+
<operations public="true" package="true" protected="true" private="true" static="true"/>
11+
</display>
12+
</interface>
13+
<interface id="2" language="java" name="com.iluwatar.abstractdocument.domain.HasModel" project="design-patterns"
14+
file="/design-patterns/src/com/iluwatar/abstractdocument/domain/HasModel.java" binary="false" corner="BOTTOM_RIGHT">
15+
<position height="81" width="173" x="41" y="194"/>
16+
<display autosize="true" stereotype="true" package="true" initial-value="false" signature="true"
17+
sort-features="false" accessors="true" visibility="true">
18+
<attributes public="true" package="true" protected="true" private="true" static="true"/>
19+
<operations public="true" package="true" protected="true" private="true" static="true"/>
20+
</display>
21+
</interface>
22+
<interface id="3" language="java" name="com.iluwatar.abstractdocument.domain.HasPrice" project="design-patterns"
23+
file="/design-patterns/src/com/iluwatar/abstractdocument/domain/HasPrice.java" binary="false" corner="BOTTOM_RIGHT">
24+
<position height="81" width="175" x="254" y="194"/>
25+
<display autosize="true" stereotype="true" package="true" initial-value="false" signature="true"
26+
sort-features="false" accessors="true" visibility="true">
27+
<attributes public="true" package="true" protected="true" private="true" static="true"/>
28+
<operations public="true" package="true" protected="true" private="true" static="true"/>
29+
</display>
30+
</interface>
31+
<interface id="4" language="java" name="com.iluwatar.abstractdocument.domain.HasParts" project="design-patterns"
32+
file="/design-patterns/src/com/iluwatar/abstractdocument/domain/HasParts.java" binary="false" corner="BOTTOM_RIGHT">
33+
<position height="81" width="173" x="469" y="194"/>
34+
<display autosize="true" stereotype="true" package="true" initial-value="false" signature="true"
35+
sort-features="false" accessors="true" visibility="true">
36+
<attributes public="true" package="true" protected="true" private="true" static="true"/>
37+
<operations public="true" package="true" protected="true" private="true" static="true"/>
38+
</display>
39+
</interface>
40+
<class id="5" language="java" name="com.iluwatar.abstractdocument.domain.Car" project="design-patterns"
41+
file="/design-patterns/src/com/iluwatar/abstractdocument/domain/Car.java" binary="false" corner="BOTTOM_RIGHT">
42+
<position height="99" width="173" x="254" y="37"/>
43+
<display autosize="true" stereotype="true" package="true" initial-value="false" signature="true"
44+
sort-features="false" accessors="true" visibility="true">
45+
<attributes public="true" package="true" protected="true" private="true" static="true"/>
46+
<operations public="true" package="true" protected="true" private="true" static="true"/>
47+
</display>
48+
</class>
49+
<class id="6" language="java" name="com.iluwatar.abstractdocument.domain.Part" project="design-patterns"
50+
file="/design-patterns/src/com/iluwatar/abstractdocument/domain/Part.java" binary="false" corner="BOTTOM_RIGHT">
51+
<position height="99" width="173" x="41" y="37"/>
52+
<display autosize="true" stereotype="true" package="true" initial-value="false" signature="true"
53+
sort-features="false" accessors="true" visibility="true">
54+
<attributes public="true" package="true" protected="true" private="true" static="true"/>
55+
<operations public="true" package="true" protected="true" private="true" static="true"/>
56+
</display>
57+
</class>
58+
<realization id="7">
59+
<end type="SOURCE" refId="5"/>
60+
<end type="TARGET" refId="2"/>
61+
</realization>
62+
<realization id="8">
63+
<end type="SOURCE" refId="6"/>
64+
<end type="TARGET" refId="2"/>
65+
</realization>
66+
<generalization id="9">
67+
<end type="SOURCE" refId="2"/>
68+
<end type="TARGET" refId="1"/>
69+
</generalization>
70+
<realization id="10">
71+
<end type="SOURCE" refId="5"/>
72+
<end type="TARGET" refId="3"/>
73+
</realization>
74+
<realization id="11">
75+
<end type="SOURCE" refId="5"/>
76+
<end type="TARGET" refId="4"/>
77+
</realization>
78+
<generalization id="12">
79+
<end type="SOURCE" refId="3"/>
80+
<end type="TARGET" refId="1"/>
81+
</generalization>
82+
<generalization id="13">
83+
<end type="SOURCE" refId="4"/>
84+
<end type="TARGET" refId="1"/>
85+
</generalization>
86+
<realization id="14">
87+
<end type="SOURCE" refId="6"/>
88+
<end type="TARGET" refId="3"/>
89+
</realization>
90+
<classifier-display autosize="true" stereotype="true" package="true" initial-value="false" signature="true"
91+
sort-features="false" accessors="true" visibility="true">
92+
<attributes public="true" package="true" protected="true" private="true" static="true"/>
93+
<operations public="true" package="true" protected="true" private="true" static="true"/>
94+
</classifier-display>
95+
<association-display labels="true" multiplicity="true"/>
96+
</class-diagram>

‎abstract-document/pom.xml‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!--
3+
4+
The MIT License
5+
Copyright (c) 2014 Ilkka Seppälä
6+
7+
Permission is hereby granted, free of charge, to any person obtaining a copy
8+
of this software and associated documentation files (the "Software"), to deal
9+
in the Software without restriction, including without limitation the rights
10+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11+
copies of the Software, and to permit persons to whom the Software is
12+
furnished to do so, subject to the following conditions:
13+
14+
The above copyright notice and this permission notice shall be included in
15+
all copies or substantial portions of the Software.
16+
17+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23+
THE SOFTWARE.
24+
25+
-->
26+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
27+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
28+
<modelVersion>4.0.0</modelVersion>
29+
<parent>
30+
<artifactId>java-design-patterns</artifactId>
31+
<groupId>com.iluwatar</groupId>
32+
<version>1.12.0-SNAPSHOT</version>
33+
</parent>
34+
<artifactId>abstract-document</artifactId>
35+
<dependencies>
36+
<dependency>
37+
<groupId>junit</groupId>
38+
<artifactId>junit</artifactId>
39+
<scope>test</scope>
40+
</dependency>
41+
</dependencies>
42+
</project>

‎abstract-document/src/main/java/com/iluwatar/abstractdocument/AbstractDocument.java‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
/**
2+
* The MIT License
3+
* Copyright (c) 2014 Ilkka Seppälä
4+
* <p>
5+
* Permission is hereby granted, free of charge, to any person obtaining a copy
6+
* of this software and associated documentation files (the "Software"), to deal
7+
* in the Software without restriction, including without limitation the rights
8+
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
* copies of the Software, and to permit persons to whom the Software is
10+
* furnished to do so, subject to the following conditions:
11+
* <p>
12+
* The above copyright notice and this permission notice shall be included in
13+
* all copies or substantial portions of the Software.
14+
* <p>
15+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
* THE SOFTWARE.
22+
*/
23+
package com.iluwatar.abstractdocument;
24+
25+
import java.util.List;
26+
import java.util.Map;
27+
import java.util.Objects;
28+
import java.util.Optional;
29+
import java.util.function.Function;
30+
import java.util.stream.Stream;
31+
32+
/**
33+
* Abstract implementation of Document interface
34+
*/
35+
public abstract class AbstractDocument implements Document {
36+
37+
private final Map<String, Object> properties;
38+
39+
protected AbstractDocument(Map<String, Object> properties) {
40+
Objects.requireNonNull(properties, "properties map is required");
41+
this.properties = properties;
42+
}
43+
44+
@Override
45+
public Void put(String key, Object value) {
46+
properties.put(key, value);
47+
return null;
48+
}
49+
50+
@Override
51+
public Object get(String key) {
52+
return properties.get(key);
53+
}
54+
55+
@Override
56+
public <T> Stream<T> children(String key, Function<Map<String, Object>, T> constructor) {
57+
Optional<List<Map<String, Object>>> any = Stream.of(get(key)).filter(el -> el != null)
58+
.map(el -> (List<Map<String, Object>>) el).findAny();
59+
return any.isPresent() ? any.get().stream().map(constructor) : Stream.empty();
60+
}
61+
62+
@Override
63+
public String toString() {
64+
StringBuilder builder = new StringBuilder();
65+
builder.append(getClass().getName()).append("[");
66+
properties.entrySet()
67+
.forEach(e -> builder.append("[").append(e.getKey()).append(" : ").append(e.getValue()).append("]"));
68+
builder.append("]");
69+
return builder.toString();
70+
}
71+
72+
}

‎abstract-document/src/main/java/com/iluwatar/abstractdocument/App.java‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
/**
2+
* The MIT License
3+
* Copyright (c) 2014 Ilkka Seppälä
4+
* <p>
5+
* Permission is hereby granted, free of charge, to any person obtaining a copy
6+
* of this software and associated documentation files (the "Software"), to deal
7+
* in the Software without restriction, including without limitation the rights
8+
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
* copies of the Software, and to permit persons to whom the Software is
10+
* furnished to do so, subject to the following conditions:
11+
* <p>
12+
* The above copyright notice and this permission notice shall be included in
13+
* all copies or substantial portions of the Software.
14+
* <p>
15+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
* THE SOFTWARE.
22+
*/
23+
package com.iluwatar.abstractdocument;
24+
25+
import com.iluwatar.abstractdocument.domain.Car;
26+
import com.iluwatar.abstractdocument.domain.HasModel;
27+
import com.iluwatar.abstractdocument.domain.HasParts;
28+
import com.iluwatar.abstractdocument.domain.HasPrice;
29+
import com.iluwatar.abstractdocument.domain.HasType;
30+
31+
import java.util.Arrays;
32+
import java.util.HashMap;
33+
import java.util.Map;
34+
35+
/**
36+
* The Abstract Document pattern enables handling additional, non-static
37+
* properties. This pattern uses concept of traits to enable type safety and
38+
* separate properties of different classes into set of interfaces.
39+
* <p>
40+
* <p>
41+
* In Abstract Document pattern,({@link AbstractDocument}) fully implements
42+
* {@link Document}) interface. Traits are then defined to enable access to
43+
* properties in usual, static way.
44+
*/
45+
public class App {
46+
47+
/**
48+
* Executes the App
49+
*/
50+
public App() {
51+
System.out.println("Constructing parts and car");
52+
53+
Map<String, Object> carProperties = new HashMap<>();
54+
carProperties.put(HasModel.PROPERTY, "300SL");
55+
carProperties.put(HasPrice.PROPERTY, 10000L);
56+
57+
Map<String, Object> wheelProperties = new HashMap<>();
58+
wheelProperties.put(HasType.PROPERTY, "wheel");
59+
wheelProperties.put(HasModel.PROPERTY, "15C");
60+
wheelProperties.put(HasPrice.PROPERTY, 100L);
61+
62+
Map<String, Object> doorProperties = new HashMap<>();
63+
doorProperties.put(HasType.PROPERTY, "door");
64+
doorProperties.put(HasModel.PROPERTY, "Lambo");
65+
doorProperties.put(HasPrice.PROPERTY, 300L);
66+
67+
carProperties.put(HasParts.PROPERTY, Arrays.asList(wheelProperties, doorProperties));
68+
69+
Car car = new Car(carProperties);
70+
71+
System.out.println("Here is our car:");
72+
System.out.println("-> model: " + car.getModel().get());
73+
System.out.println("-> price: " + car.getPrice().get());
74+
System.out.println("-> parts: ");
75+
car.getParts().forEach(p -> System.out
76+
.println("\t" + p.getType().get() + "/" + p.getModel().get() + "/" + p.getPrice().get()));
77+
}
78+
79+
/**
80+
* Program entry point
81+
*
82+
* @param args command line args
83+
*/
84+
public static void main(String[] args) {
85+
new App();
86+
}
87+
88+
}

0 commit comments

Comments
 (0)