| /* |
| * Licensed to the Apache Software Foundation (ASF) under one or more |
| * contributor license agreements. See the NOTICE file distributed with |
| * this work for additional information regarding copyright ownership. |
| * The ASF licenses this file to You under the Apache License, Version 2.0 |
| * (the "License"); you may not use this file except in compliance with |
| * the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| package org.apache.sis.metadata; |
| |
| import java.util.Map; |
| import java.util.Collection; |
| import org.opengis.util.InternationalString; |
| import org.opengis.metadata.Identifier; |
| import org.apache.sis.xml.NilReason; |
| import org.apache.sis.util.SimpleInternationalString; |
| import org.apache.sis.metadata.iso.citation.DefaultCitation; |
| import org.apache.sis.metadata.iso.citation.DefaultIndividual; |
| import org.apache.sis.metadata.iso.citation.DefaultResponsibleParty; |
| import org.apache.sis.test.DependsOnMethod; |
| import org.apache.sis.test.DependsOn; |
| import org.apache.sis.test.TestCase; |
| import org.junit.Test; |
| |
| import static org.opengis.test.Assert.*; |
| import static java.util.AbstractMap.SimpleEntry; |
| import static java.util.Collections.emptySet; |
| import static java.util.Collections.emptyList; |
| import static java.util.Collections.singleton; |
| import static java.util.Collections.singletonList; |
| import static org.opengis.metadata.citation.PresentationForm.DOCUMENT_HARDCOPY; |
| import static org.apache.sis.test.TestUtilities.getSingleton; |
| |
| |
| /** |
| * Tests the {@link ValueMap} class on instances created by |
| * {@link MetadataStandard#asValueMap(Object, Class, KeyNamePolicy, ValueExistencePolicy)}. |
| * Unless otherwise specified, all tests use the {@link MetadataStandard#ISO_19115} constant. |
| * |
| * @author Martin Desruisseaux (Geomatys) |
| * @version 1.2 |
| * |
| * @see MetadataStandardTest#testValueMap() |
| * |
| * @since 0.3 |
| * @module |
| */ |
| @DependsOn(PropertyAccessorTest.class) |
| public final strictfp class ValueMapTest extends TestCase { |
| /** |
| * The citation instance created by {@link #createCitation()}. |
| */ |
| private DefaultCitation citation; |
| |
| /** |
| * The title of the metadata instance created by {@link #createCitation()}. |
| */ |
| private InternationalString title; |
| |
| /** |
| * The author of the metadata instance created by {@link #createCitation()}. |
| */ |
| private DefaultResponsibleParty author; |
| |
| /** |
| * Creates the metadata instance to be used for testing purpose. |
| * This method creates the following metadata |
| * (ignoring identifiers, which will be inferred from the ISBN value): |
| * |
| * {@preformat text |
| * Citation |
| * ├─Title…………………………………………………… Undercurrent |
| * ├─Edition……………………………………………… <nil:unknown> |
| * ├─Cited Responsible Parties |
| * │ └─Individual Name……………… Testsuya Toyoda |
| * └─ISBN……………………………………………………… 9782505004509 |
| * } |
| * |
| * The citation instance is stored in the {@link #citation} field. |
| * The title and author instances are stored in the {@link #title} and {@link #author} fields. |
| * |
| * @return the map view of the citation create by this method. |
| */ |
| private Map<String,Object> createCitation() { |
| title = new SimpleInternationalString("Undercurrent"); |
| author = new DefaultResponsibleParty(); |
| citation = new DefaultCitation(title); |
| author.setParties(singleton(new DefaultIndividual("Testsuya Toyoda", null, null))); |
| citation.setCitedResponsibleParties(singleton(author)); |
| citation.setISBN("9782505004509"); |
| citation.setEdition(NilReason.UNKNOWN.createNilObject(InternationalString.class)); |
| return MetadataStandard.ISO_19115.asValueMap(citation, null, KeyNamePolicy.JAVABEANS_PROPERTY, ValueExistencePolicy.NON_EMPTY); |
| } |
| |
| /** |
| * Tests the {@link ValueMap#get(Object)} method. |
| */ |
| @Test |
| public void testGet() { |
| final Map<String,Object> map = createCitation(); |
| assertEquals("Undercurrent", map.get("title").toString()); |
| assertEquals(singletonList(author), map.get("citedResponsibleParties")); |
| assertEquals("9782505004509", map.get("ISBN")); |
| assertNull ("NilObject shall be excluded.", map.get("edition")); |
| /* |
| * The ISBN shall also be visible as an identifier. |
| */ |
| final Object identifiers = map.get("identifiers"); |
| assertInstanceOf("identifiers", Collection.class, identifiers); |
| final Object identifier = getSingleton((Collection<?>) identifiers); |
| assertInstanceOf("identifier", Identifier.class, identifier); |
| assertEquals("9782505004509", ((Identifier) identifier).getCode()); |
| } |
| |
| /** |
| * Tests the {@link ValueMap#entrySet()} method. |
| * The expected metadata is: |
| * |
| * {@preformat text |
| * Citation |
| * ├─Title…………………………………………………… Undercurrent |
| * ├─Identifiers…………………………………… 9782505004509 |
| * ├─Cited Responsible Parties |
| * │ └─Individual Name……………… Testsuya Toyoda |
| * └─ISBN……………………………………………………… 9782505004509 |
| * } |
| * |
| * Note that this test is intentionally sensitive to iteration order. |
| * That order shall be fixed by the {@code XmlType} annotation. |
| */ |
| @Test |
| @DependsOnMethod("testGet") |
| public void testEntrySet() { |
| final Map<String,Object> map = createCitation(); |
| assertEquals(1, citation.getIdentifiers().size()); |
| assertArrayEquals(new SimpleEntry<?,?>[] { |
| new SimpleEntry<>("title", title), |
| new SimpleEntry<>("identifiers", citation.getIdentifiers()), |
| new SimpleEntry<>("citedResponsibleParties", singletonList(author)), |
| new SimpleEntry<>("ISBN", "9782505004509") |
| }, map.entrySet().toArray()); |
| } |
| |
| /** |
| * Tests the {@link ValueMap#entrySet()} method for the same metadata than {@link #testEntrySet()}, |
| * but asking for all non-null and non-nil entries including the empty collections. |
| */ |
| @Test |
| @DependsOnMethod("testEntrySet") |
| public void testEntrySetForNonNil() { |
| final Map<String,Object> map = createCitation(); |
| final Map<String,Object> all = MetadataStandard.ISO_19115.asValueMap(citation, |
| null, KeyNamePolicy.JAVABEANS_PROPERTY, ValueExistencePolicy.NON_NIL); |
| assertFalse("Null values shall be excluded.", map.containsKey("alternateTitles")); |
| assertTrue ("Null values shall be included.", all.containsKey("alternateTitles")); |
| assertFalse("Nil objects shall be excluded.", map.containsKey("edition")); |
| assertFalse("Nil objects shall be excluded.", all.containsKey("edition")); |
| assertTrue ("'all' shall be a larger map than 'map'.", all.entrySet().containsAll(map.entrySet())); |
| assertFalse("'all' shall be a larger map than 'map'.", map.entrySet().containsAll(all.entrySet())); |
| assertArrayEquals(new SimpleEntry<?,?>[] { |
| new SimpleEntry<>("title", title), |
| new SimpleEntry<>("alternateTitles", emptyList()), |
| new SimpleEntry<>("dates", emptyList()), |
| new SimpleEntry<>("identifiers", citation.getIdentifiers()), |
| new SimpleEntry<>("citedResponsibleParties", singletonList(author)), |
| new SimpleEntry<>("presentationForms", emptySet()), |
| new SimpleEntry<>("ISBN", "9782505004509"), |
| new SimpleEntry<>("onlineResources", emptyList()), |
| new SimpleEntry<>("graphics", emptyList()) |
| }, all.entrySet().toArray()); |
| } |
| |
| /** |
| * Tests the {@link ValueMap#entrySet()} method for the same metadata than {@link #testEntrySet()}, |
| * but asking for all non-null entries including nil objects and the empty collections. |
| */ |
| @Test |
| @DependsOnMethod("testEntrySet") |
| public void testEntrySetForNonNull() { |
| final Map<String,Object> map = createCitation(); |
| final Map<String,Object> all = MetadataStandard.ISO_19115.asValueMap(citation, |
| null, KeyNamePolicy.JAVABEANS_PROPERTY, ValueExistencePolicy.NON_NULL); |
| assertFalse("Null values shall be excluded.", map.containsKey("alternateTitles")); |
| assertTrue ("Null values shall be included.", all.containsKey("alternateTitles")); |
| assertFalse("Nil objects shall be excluded.", map.containsKey("edition")); |
| assertTrue ("Nil objects shall be included.", all.containsKey("edition")); |
| assertTrue ("'all' shall be a larger map than 'map'.", all.entrySet().containsAll(map.entrySet())); |
| assertFalse("'all' shall be a larger map than 'map'.", map.entrySet().containsAll(all.entrySet())); |
| assertArrayEquals(new SimpleEntry<?,?>[] { |
| new SimpleEntry<>("title", title), |
| new SimpleEntry<>("alternateTitles", emptyList()), |
| new SimpleEntry<>("dates", emptyList()), |
| new SimpleEntry<>("edition", NilReason.UNKNOWN.createNilObject(InternationalString.class)), |
| new SimpleEntry<>("identifiers", citation.getIdentifiers()), |
| new SimpleEntry<>("citedResponsibleParties", singletonList(author)), |
| new SimpleEntry<>("presentationForms", emptySet()), |
| new SimpleEntry<>("ISBN", "9782505004509"), |
| new SimpleEntry<>("onlineResources", emptyList()), |
| new SimpleEntry<>("graphics", emptyList()) |
| }, all.entrySet().toArray()); |
| } |
| |
| /** |
| * Tests the {@link ValueMap#entrySet()} method for the same metadata than {@link #testEntrySet()}, |
| * but asking for all entries including null and empty values. |
| */ |
| @Test |
| @DependsOnMethod("testEntrySet") |
| public void testEntrySetForAll() { |
| final Map<String,Object> map = createCitation(); |
| final Map<String,Object> all = MetadataStandard.ISO_19115.asValueMap(citation, |
| null, KeyNamePolicy.JAVABEANS_PROPERTY, ValueExistencePolicy.ALL); |
| assertFalse("Null values shall be excluded.", map.containsKey("alternateTitles")); |
| assertTrue ("Null values shall be included.", all.containsKey("alternateTitles")); |
| assertTrue ("'all' shall be a larger map than 'map'.", all.entrySet().containsAll(map.entrySet())); |
| assertFalse("'all' shall be a larger map than 'map'.", map.entrySet().containsAll(all.entrySet())); |
| assertArrayEquals(new SimpleEntry<?,?>[] { |
| new SimpleEntry<>("title", title), |
| new SimpleEntry<>("alternateTitles", emptyList()), |
| new SimpleEntry<>("dates", emptyList()), |
| new SimpleEntry<>("edition", NilReason.UNKNOWN.createNilObject(InternationalString.class)), |
| new SimpleEntry<>("editionDate", null), |
| new SimpleEntry<>("identifiers", citation.getIdentifiers()), |
| new SimpleEntry<>("citedResponsibleParties", singletonList(author)), |
| new SimpleEntry<>("presentationForms", emptySet()), |
| new SimpleEntry<>("series", null), |
| new SimpleEntry<>("otherCitationDetails", null), |
| // new SimpleEntry<>("collectiveTitle", null), -- deprecated as of ISO 19115:2014. |
| new SimpleEntry<>("ISBN", "9782505004509"), |
| new SimpleEntry<>("ISSN", null), |
| new SimpleEntry<>("onlineResources", emptyList()), |
| new SimpleEntry<>("graphics", emptyList()) |
| }, all.entrySet().toArray()); |
| } |
| |
| /** |
| * Tests the {@link ValueMap#put(String,Object)} and {@link ValueMap#remove(Object)} methods. |
| * Note that this test is intentionally sensitive to iteration order. |
| * That order shall be fixed by the {@code XmlType} annotation. |
| */ |
| @Test |
| @DependsOnMethod("testEntrySet") |
| public void testPutAndRemove() { |
| final Map<String,Object> map = createCitation(); |
| /* |
| * Remove the ISBN value. Result shall be: |
| * |
| * Citation |
| * ├─Title…………………………………………………… Undercurrent |
| * └─Cited Responsible Parties |
| * └─Individual Name……………… Testsuya Toyoda |
| */ |
| assertEquals("9782505004509", map.remove("ISBN")); |
| assertNull("ISBN shall have been removed.", citation.getISBN()); |
| assertTrue("ISBN shall have been removed.", citation.getIdentifiers().isEmpty()); |
| assertArrayEquals(new SimpleEntry<?,?>[] { |
| new SimpleEntry<>("title", title), |
| new SimpleEntry<>("citedResponsibleParties", singletonList(author)) |
| }, map.entrySet().toArray()); |
| /* |
| * Add a value. Result shall be: |
| * |
| * Citation |
| * ├─Title…………………………………………………… Undercurrent |
| * ├─Cited Responsible Parties |
| * │ └─Individual Name……………… Testsuya Toyoda |
| * └─Presentation Forms………………… document hardcopy |
| */ |
| assertNull(map.put("presentationForm", DOCUMENT_HARDCOPY)); |
| assertEquals(DOCUMENT_HARDCOPY, getSingleton(citation.getPresentationForms())); |
| assertArrayEquals(new SimpleEntry<?,?>[] { |
| new SimpleEntry<>("title", title), |
| new SimpleEntry<>("citedResponsibleParties", singletonList(author)), |
| new SimpleEntry<>("presentationForms", singleton(DOCUMENT_HARDCOPY)) |
| }, map.entrySet().toArray()); |
| /* |
| * Add back the ISBN value. Result shall be: |
| * |
| * Citation |
| * ├─Title…………………………………………………… Undercurrent |
| * ├─Identifiers…………………………………… 9782505004509 |
| * ├─Cited Responsible Parties |
| * │ └─Individual Name……………… Testsuya Toyoda |
| * ├─Presentation Forms………………… document hardcopy |
| * └─ISBN……………………………………………………… 9782505004509 |
| */ |
| assertNull(map.put("ISBN", "9782505004509")); |
| assertEquals("9782505004509", citation.getISBN()); |
| assertEquals("ISBN shall appears in the identifier list.", 1, citation.getIdentifiers().size()); |
| assertArrayEquals(new SimpleEntry<?,?>[] { |
| new SimpleEntry<>("title", title), |
| new SimpleEntry<>("identifiers", citation.getIdentifiers()), |
| new SimpleEntry<>("citedResponsibleParties", singletonList(author)), |
| new SimpleEntry<>("presentationForms", singleton(DOCUMENT_HARDCOPY)), |
| new SimpleEntry<>("ISBN", "9782505004509") |
| }, map.entrySet().toArray()); |
| } |
| |
| /** |
| * Tests {@link ValueMap#putIfAbsent(String, Object)}. |
| */ |
| @Test |
| public void testPutIfAbsent() { |
| final Map<String, Object> citation = createCitation(); |
| assertEquals("Undercurrent", String.valueOf(citation.putIfAbsent("title", "A new title"))); |
| assertEquals("Undercurrent", String.valueOf(citation.get("title"))); |
| assertEquals("Undercurrent", String.valueOf(citation.remove("title"))); |
| assertNull(citation.putIfAbsent("title", "A new title")); |
| assertEquals("A new title", String.valueOf(citation.get("title"))); |
| } |
| } |
