application/sis-console/src/main/java/org/apache/sis/console/IdentifierCommand.java - sis - Git at Google

 /*
  * 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.console;

 import java.io.IOException;
 import java.util.List;
 import java.util.ArrayList;
 import java.util.Set;
 import java.util.EnumSet;
 import java.util.Collections;
 import java.util.ResourceBundle;
 import org.opengis.metadata.Metadata;
 import org.opengis.metadata.Identifier;
 import org.opengis.referencing.NoSuchAuthorityCodeException;
 import org.opengis.util.FactoryException;
 import org.opengis.referencing.ReferenceSystem;
 import org.apache.sis.internal.util.X364;
 import org.apache.sis.referencing.CRS;
 import org.apache.sis.referencing.IdentifiedObjects;
 import org.apache.sis.util.CharSequences;
 import org.apache.sis.util.ComparisonMode;
 import org.apache.sis.util.Workaround;
 import org.apache.sis.util.resources.Vocabulary;

 // Branch-dependent imports
 import org.apache.sis.metadata.iso.DefaultMetadata;
 import org.apache.sis.metadata.iso.DefaultIdentifier;


 /**
  * The "identifier" sub-command.
  *
  * @author  Martin Desruisseaux (Geomatys)
  * @version 0.8
  * @since   0.3
  * @module
  */
 final class IdentifierCommand extends FormattedOutputCommand {
     /**
      * The state to write in the left margin before the identifier.
      *
      * <b>MAINTENANCE NOTE:</b> if this enumeration is modified,
      * update {@code IdentifierState.properties} accordingly.
      */
     private enum State {
         VALID("   "), APPROXIMATE("~  "), AXIS_ORDER("!  "), MISMATCH("!! "), UNKNOWN("?  ");

         /** The string representation. */ final String text;
         private State(final String p) {this.text = p;};
     }

     /**
      * A row containing a metadata or CRS identifier, its name and a status flag.
      */
     private static class Row {
         /**
          * The two-letters state to write before the identifier.
          */
         final State state;

         /**
          * The identifier.
          */
         final String identifier;

         /**
          * A description to write after the identifier.
          */
         final CharSequence description;

         /**
          * Creates a row for the given elements.
          */
         Row(final State state, final String identifier, final CharSequence description) {
             this.state       = state;
             this.identifier  = identifier;
             this.description = description;
         }
     }

     /**
      * Work around for RFE #4093999 in Sun's bug database
      * ("Relax constraint on placement of this()/super() call in constructors").
      */
     @Workaround(library="JDK", version="1.7")
     private static EnumSet<Option> options() {
         final EnumSet<Option> options = MetadataCommand.options();
         options.remove(Option.TIMEZONE);
         options.remove(Option.FORMAT);
         return options;
     }

     /**
      * Creates the {@code "identifier"} sub-command.
      */
     IdentifierCommand(final int commandIndex, final String... args) throws InvalidOptionException {
         super(commandIndex, args, options(), OutputFormat.TEXT);
     }

     /**
      * Prints identifier information.
      *
      * @return 0 on success, or an exit code if the command failed for a reason other than an uncaught Java exception.
      */
     @Override
     public int run() throws Exception {
         /*
          * Read metadata from the data storage only after we verified that the arguments are valid.
          * The input can be a file given on the command line, or the standard input stream.
          */
         Object metadata = readMetadataOrCRS();
         if (hasUnexpectedFileCount) {
             return Command.INVALID_ARGUMENT_EXIT_CODE;
         }
         if (metadata != null) {
             final List<Row> rows;
             if (metadata instanceof DefaultMetadata) {
                 rows = new ArrayList<>();
                 final Identifier id = ((DefaultMetadata) metadata).getMetadataIdentifier();
                 if (id instanceof DefaultIdentifier) {
                     CharSequence desc = ((DefaultIdentifier) id).getDescription();
                     if (desc != null && !files.isEmpty()) desc = files.get(0);
                     rows.add(new Row(State.VALID, IdentifiedObjects.toString(id), desc));
                 }
                 for (final ReferenceSystem rs : ((Metadata) metadata).getReferenceSystemInfo()) {
                     rows.add(create(rs));
                 }
             } else {
                 rows = Collections.singletonList(create((ReferenceSystem) metadata));
             }
             print(rows);
         }
         return 0;
     }

     /**
      * Creates an identifier row for the given CRS.
      * This method gives precedence to {@code "urn:ogc:def:"} identifiers if possible.
      *
      * @return the row, or {@code null} if no identifier has been found.
      */
     static Row create(ReferenceSystem rs) throws FactoryException {
         String identifier = IdentifiedObjects.lookupURN(rs, null);
         if (identifier == null) {
             /*
              * If we can not find an identifier matching the EPSG or WMS definitions,
              * look at the identifiers declared in the CRS and verify their validity.
              */
             for (final Identifier id : rs.getIdentifiers()) {
                 final String c = IdentifiedObjects.toURN(rs.getClass(), id);
                 if (c != null) {
                     identifier = c;
                     break;                                          // Stop at the first "urn:ogc:def:…".
                 }
                 if (identifier == null) {
                     identifier = IdentifiedObjects.toString(id);    // "AUTHORITY:CODE" as a fallback if no URN.
                 }
             }
             if (identifier == null) {
                 return null;                                        // No identifier found.
             }
         }
         /*
          * The CRS provided by the user contains identifier, but the 'lookupURN' operation above failed to
          * find it. The most likely cause is that the user-provided CRS does not use the same axis order.
          */
         State state;
         try {
             final ReferenceSystem def = CRS.forCode(identifier);
             final ComparisonMode c = ComparisonMode.equalityLevel(def, rs);
             if (c == null) {
                 state = State.MISMATCH;
             } else switch (c) {
                 case ALLOW_VARIANT: {
                     state = State.AXIS_ORDER;
                     break;
                 }
                 case APPROXIMATE: {
                     state = State.APPROXIMATE;
                     rs = def;
                     break;
                 }
                 default: {
                     state = State.VALID;
                     rs = def;
                     break;
                 }
             }
         } catch (NoSuchAuthorityCodeException e) {
             state = State.UNKNOWN;
         }
         return new Row(state, identifier, rs.getName().getCode());
     }

     /**
      * Prints all non-null rows.
      */
     private void print(final Iterable<Row> rows) throws IOException {
         int width = 0;
         for (final Row row : rows) {
             if (row != null) {
                 width = Math.max(width, row.identifier.length());
             }
         }
         width += 4;
         final Set<State> states = EnumSet.noneOf(State.class);
         for (final Row row : rows) {
             if (row != null) {
                 states.add(row.state);
                 final boolean warning = colors && row.state.text.startsWith("!");
                 if (warning) out.print(X364.FOREGROUND_RED.sequence());
                 out.print(row.state.text);
                 out.print(' ');
                 out.print(row.identifier);
                 if (warning) out.print(X364.FOREGROUND_DEFAULT.sequence());
                 if (colors)  out.print(X364.FOREGROUND_GRAY.sequence());
                 out.print(CharSequences.spaces(width - row.identifier.length()));
                 out.print("| ");
                 out.println(row.description);
                 if (colors) out.print(X364.FOREGROUND_DEFAULT.sequence());
             }
         }
         states.remove(State.VALID);
         if (!states.isEmpty()) {
             out.println();
             Vocabulary.getResources(locale).appendLabel(Vocabulary.Keys.Legend, out);
             out.println();
             final ResourceBundle resources = ResourceBundle.getBundle("org.apache.sis.console.IdentifierState", locale);
             for (final State state : states) {
                 final boolean warning = colors && state.text.startsWith("!");
                 if (warning) out.print(X364.FOREGROUND_RED.sequence());
                 out.print(state.text);
                 if (warning) out.print(X364.FOREGROUND_DEFAULT.sequence());
                 out.print(' ');
                 out.println(resources.getString(state.name()));
             }
         }
         out.flush();
     }
 }
	/*
	* 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.console;

	import java.io.IOException;
	import java.util.List;
	import java.util.ArrayList;
	import java.util.Set;
	import java.util.EnumSet;
	import java.util.Collections;
	import java.util.ResourceBundle;
	import org.opengis.metadata.Metadata;
	import org.opengis.metadata.Identifier;
	import org.opengis.referencing.NoSuchAuthorityCodeException;
	import org.opengis.util.FactoryException;
	import org.opengis.referencing.ReferenceSystem;
	import org.apache.sis.internal.util.X364;
	import org.apache.sis.referencing.CRS;
	import org.apache.sis.referencing.IdentifiedObjects;
	import org.apache.sis.util.CharSequences;
	import org.apache.sis.util.ComparisonMode;
	import org.apache.sis.util.Workaround;
	import org.apache.sis.util.resources.Vocabulary;

	// Branch-dependent imports
	import org.apache.sis.metadata.iso.DefaultMetadata;
	import org.apache.sis.metadata.iso.DefaultIdentifier;


	/**
	* The "identifier" sub-command.
	*
	* @author Martin Desruisseaux (Geomatys)
	* @version 0.8
	* @since 0.3
	* @module
	*/
	final class IdentifierCommand extends FormattedOutputCommand {
	/**
	* The state to write in the left margin before the identifier.
	*
	* <b>MAINTENANCE NOTE:</b> if this enumeration is modified,
	* update {@code IdentifierState.properties} accordingly.
	*/
	private enum State {
	VALID(" "), APPROXIMATE("~ "), AXIS_ORDER("! "), MISMATCH("!! "), UNKNOWN("? ");

	/** The string representation. */ final String text;
	private State(final String p) {this.text = p;};
	}

	/**
	* A row containing a metadata or CRS identifier, its name and a status flag.
	*/
	private static class Row {
	/**
	* The two-letters state to write before the identifier.
	*/
	final State state;

	/**
	* The identifier.
	*/
	final String identifier;

	/**
	* A description to write after the identifier.
	*/
	final CharSequence description;

	/**
	* Creates a row for the given elements.
	*/
	Row(final State state, final String identifier, final CharSequence description) {
	this.state = state;
	this.identifier = identifier;
	this.description = description;
	}
	}

	/**
	* Work around for RFE #4093999 in Sun's bug database
	* ("Relax constraint on placement of this()/super() call in constructors").
	*/
	@Workaround(library="JDK", version="1.7")
	private static EnumSet<Option> options() {
	final EnumSet<Option> options = MetadataCommand.options();
	options.remove(Option.TIMEZONE);
	options.remove(Option.FORMAT);
	return options;
	}

	/**
	* Creates the {@code "identifier"} sub-command.
	*/
	IdentifierCommand(final int commandIndex, final String... args) throws InvalidOptionException {
	super(commandIndex, args, options(), OutputFormat.TEXT);
	}

	/**
	* Prints identifier information.
	*
	* @return 0 on success, or an exit code if the command failed for a reason other than an uncaught Java exception.
	*/
	@Override
	public int run() throws Exception {
	/*
	* Read metadata from the data storage only after we verified that the arguments are valid.
	* The input can be a file given on the command line, or the standard input stream.
	*/
	Object metadata = readMetadataOrCRS();
	if (hasUnexpectedFileCount) {
	return Command.INVALID_ARGUMENT_EXIT_CODE;
	}
	if (metadata != null) {
	final List<Row> rows;
	if (metadata instanceof DefaultMetadata) {
	rows = new ArrayList<>();
	final Identifier id = ((DefaultMetadata) metadata).getMetadataIdentifier();
	if (id instanceof DefaultIdentifier) {
	CharSequence desc = ((DefaultIdentifier) id).getDescription();
	if (desc != null && !files.isEmpty()) desc = files.get(0);
	rows.add(new Row(State.VALID, IdentifiedObjects.toString(id), desc));
	}
	for (final ReferenceSystem rs : ((Metadata) metadata).getReferenceSystemInfo()) {
	rows.add(create(rs));
	}
	} else {
	rows = Collections.singletonList(create((ReferenceSystem) metadata));
	}
	print(rows);
	}
	return 0;
	}

	/**
	* Creates an identifier row for the given CRS.
	* This method gives precedence to {@code "urn:ogc:def:"} identifiers if possible.
	*
	* @return the row, or {@code null} if no identifier has been found.
	*/
	static Row create(ReferenceSystem rs) throws FactoryException {
	String identifier = IdentifiedObjects.lookupURN(rs, null);
	if (identifier == null) {
	/*
	* If we can not find an identifier matching the EPSG or WMS definitions,
	* look at the identifiers declared in the CRS and verify their validity.
	*/
	for (final Identifier id : rs.getIdentifiers()) {
	final String c = IdentifiedObjects.toURN(rs.getClass(), id);
	if (c != null) {
	identifier = c;
	break; // Stop at the first "urn:ogc:def:…".
	}
	if (identifier == null) {
	identifier = IdentifiedObjects.toString(id); // "AUTHORITY:CODE" as a fallback if no URN.
	}
	}
	if (identifier == null) {
	return null; // No identifier found.
	}
	}
	/*
	* The CRS provided by the user contains identifier, but the 'lookupURN' operation above failed to
	* find it. The most likely cause is that the user-provided CRS does not use the same axis order.
	*/
	State state;
	try {
	final ReferenceSystem def = CRS.forCode(identifier);
	final ComparisonMode c = ComparisonMode.equalityLevel(def, rs);
	if (c == null) {
	state = State.MISMATCH;
	} else switch (c) {
	case ALLOW_VARIANT: {
	state = State.AXIS_ORDER;
	break;
	}
	case APPROXIMATE: {
	state = State.APPROXIMATE;
	rs = def;
	break;
	}
	default: {
	state = State.VALID;
	rs = def;
	break;
	}
	}
	} catch (NoSuchAuthorityCodeException e) {
	state = State.UNKNOWN;
	}
	return new Row(state, identifier, rs.getName().getCode());
	}

	/**
	* Prints all non-null rows.
	*/
	private void print(final Iterable<Row> rows) throws IOException {
	int width = 0;
	for (final Row row : rows) {
	if (row != null) {
	width = Math.max(width, row.identifier.length());
	}
	}
	width += 4;
	final Set<State> states = EnumSet.noneOf(State.class);
	for (final Row row : rows) {
	if (row != null) {
	states.add(row.state);
	final boolean warning = colors && row.state.text.startsWith("!");
	if (warning) out.print(X364.FOREGROUND_RED.sequence());
	out.print(row.state.text);
	out.print(' ');
	out.print(row.identifier);
	if (warning) out.print(X364.FOREGROUND_DEFAULT.sequence());
	if (colors) out.print(X364.FOREGROUND_GRAY.sequence());
	out.print(CharSequences.spaces(width - row.identifier.length()));
	out.print("\| ");
	out.println(row.description);
	if (colors) out.print(X364.FOREGROUND_DEFAULT.sequence());
	}
	}
	states.remove(State.VALID);
	if (!states.isEmpty()) {
	out.println();
	Vocabulary.getResources(locale).appendLabel(Vocabulary.Keys.Legend, out);
	out.println();
	final ResourceBundle resources = ResourceBundle.getBundle("org.apache.sis.console.IdentifierState", locale);
	for (final State state : states) {
	final boolean warning = colors && state.text.startsWith("!");
	if (warning) out.print(X364.FOREGROUND_RED.sequence());
	out.print(state.text);
	if (warning) out.print(X364.FOREGROUND_DEFAULT.sequence());
	out.print(' ');
	out.println(resources.getString(state.name()));
	}
	}
	out.flush();
	}
	}