1 /*
2 * Copyright (c) 2012-2022, jcabi.com
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met: 1) Redistributions of source code must retain the above
8 * copyright notice, this list of conditions and the following
9 * disclaimer. 2) Redistributions in binary form must reproduce the above
10 * copyright notice, this list of conditions and the following
11 * disclaimer in the documentation and/or other materials provided
12 * with the distribution. 3) Neither the name of the jcabi.com nor
13 * the names of its contributors may be used to endorse or promote
14 * products derived from this software without specific prior written
15 * permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
19 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
20 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
21 * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
22 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
28 * OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30 package com.jcabi.simpledb;
31
32 import com.amazonaws.services.simpledb.model.SelectRequest;
33 import com.jcabi.aspects.Immutable;
34 import javax.validation.constraints.NotNull;
35
36 /**
37 * Amazon SimpleDB domain abstraction.
38 *
39 * <p>Get an item from the domain and manipulate it, for example:
40 *
41 * <pre> Region region = new Region.Simple(...);
42 * Domain domain = region.domain("employees");
43 * Item employee = domain.item("324");
44 * employee.put("Name", "Jeffrey Lebowski");
45 * for (Map.Entry<String, String> attr : employee.entrySet()) {
46 * System.out.println(attr.getKey() + ": " + attr.getValue());
47 * }</pre>
48 *
49 * @since 0.1
50 */
51 @Immutable
52 public interface Domain {
53
54 /**
55 * Create it.
56 */
57 void create();
58
59 /**
60 * Drop it.
61 */
62 void drop();
63
64 /**
65 * Get its name.
66 * @return Name of domain
67 */
68 @NotNull(message = "name is never NULL")
69 String name();
70
71 /**
72 * Get item.
73 * @param name Name of the item
74 * @return Item just created
75 */
76 @NotNull(message = "item is never NULL")
77 Item item(@NotNull String name);
78
79 /**
80 * Select multiple items.
81 * @param request Select request
82 * @return Items found
83 */
84 @NotNull(message = "collection of items is never NULL")
85 Iterable<Item> select(@NotNull SelectRequest request);
86
87 }