package X3dForWebAuthors.Chapter15Metadata;

import org.web3d.x3d.jsail.Core.*;
import org.web3d.x3d.jsail.EnvironmentalEffects.*;
import org.web3d.x3d.jsail.fields.*;
import org.web3d.x3d.jsail.Navigation.*;
import org.web3d.x3d.jsail.Networking.*;
import org.web3d.x3d.jsail.Shape.*;
import org.web3d.x3d.jsail.Text.*;

// Javadoc metadata annotations follow, see below for X3DJSAIL Java source code.
/**
 * <p> This X3D3 scene contains MetadataSet with a non-null metadata field and multiple value nodes. Also provides a test target for python x3d package development, can x3d.py package generate this valid X3D file?. </p>
 <p> Related links: Catalog page <a href="../../../Chapter15Metadata/WorldInfoExampleMetadataSetX3D3Index.html" target="_blank">WorldInfoExampleMetadataSetX3D3</a>,  source <a href="../../../Chapter15Metadata/WorldInfoExampleMetadataSetX3D3.java">WorldInfoExampleMetadataSetX3D3.java</a>, <a href="https://www.web3d.org/x3d/content/examples/X3dResources.html" target="_blank">X3D Resources</a>, <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html" target="_blank">X3D Scene Authoring Hints</a>, and <a href="https://www.web3d.org/x3d/content/X3dTooltips.html" target="_blank">X3D Tooltips</a>. </p>
	<table style="color:black; border:0px solid; border-spacing:10px 0px;">
        <caption>Scene Meta Information</caption>
		<tr style="background-color:silver; border-color:silver;">
			<td style="text-align:center; padding:10px 0px;"><i>meta tags</i></td>
			<td style="text-align:left;   padding:10px 0px;">&nbsp; Document Metadata </td>
		</tr>

		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> title </i> </td>
			<td> <a href="../../../Chapter15Metadata/WorldInfoExampleMetadataSetX3D3.x3d">WorldInfoExampleMetadataSetX3D3.x3d</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> description </i> </td>
			<td> This X3D3 scene contains MetadataSet with a non-null metadata field and multiple value nodes. Also provides a test target for python x3d package development, can x3d.py package generate this valid X3D file? </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> info </i> </td>
			<td> Metadata nodes at root level of scene are not allowed in VRML97 or X3D3, but are allowed in X3D4. </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> info </i> </td>
			<td> Metadata node as WorldInfo metadata field are not allowed in VRML97, but are allowed in X3D3 or X3D4. </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> reference </i> </td>
			<td> <a href="../../../Chapter15Metadata/WorldInfoExampleMetadataSetX3D4.x3d">WorldInfoExampleMetadataSetX3D4.x3d</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> info </i> </td>
			<td> Original name MetadataSetWithMetadata.x3d </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> creator </i> </td>
			<td> Vincent Marchetti </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> creator </i> </td>
			<td> Don Brutzman </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> created </i> </td>
			<td> 16 November 2021 </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> modified </i> </td>
			<td> 7 April 2024 </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> specificationSection </i> </td>
			<td> X3D encodings, ISO/IEC 19776-1, Part 1: XML encoding, Annex B.6.1 x3d-4.0.xsd </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> specificationUrl </i> </td>
			<td> <a href="https://web3d.org/specifications/X3Dv4Draft/ISO-IEC19776-1v4.0-WD1/Part01/Schema.html#Version4.0Schema" target="_blank">https://web3d.org/specifications/X3Dv4Draft/ISO-IEC19776-1v4.0-WD1/Part01/Schema.html#Version4.0Schema</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> generator </i> </td>
			<td> X3D-Edit 4.0, <a href="https://www.web3d.org/x3d/tools/X3D-Edit" target="_blank">https://www.web3d.org/x3d/tools/X3D-Edit</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> identifier </i> </td>
			<td> <a href="https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter15Metadata/WorldInfoExampleMetadataSetX3D3.x3d" target="_blank">https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter15Metadata/WorldInfoExampleMetadataSetX3D3.x3d</a> </td>
		</tr>
		<tr>
			<td style="text-align:right; vertical-align: text-top;"> <i> license </i> </td>
			<td> <a href="https://creativecommons.org/licenses/by/4.0" target="_blank">https://creativecommons.org/licenses/by/4.0</a> </td>
		</tr>
		<tr style="background-color:silver; border-color:silver;">
			<td style="text-align:center;" colspan="2">  &nbsp; </td>
		</tr>
	</table>

	<p>
		This program uses the
		<a href="https://www.web3d.org/specifications/java/X3DJSAIL.html" target="_blank">X3D Java Scene Access Interface Library (X3DJSAIL)</a>.
		It has been produced using the 
		<a href="https://www.web3d.org/x3d/stylesheets/X3dToJava.xslt" target="_blank">X3dToJava.xslt</a>
		stylesheet
	       (<a href="https://sourceforge.net/p/x3d/code/HEAD/tree/www.web3d.org/x3d/stylesheets/X3dToJava.xslt" target="_blank">version control</a>)
                which is used to create Java source code from an original <code>.x3d</code> model.
	</p>

	* @author Vincent Marchetti
	* @author Don Brutzman
 */

public class WorldInfoExampleMetadataSetX3D3
{
	/** Default constructor to create this object. */
	public WorldInfoExampleMetadataSetX3D3 ()
	{
	  initialize();
	}

	/** Create and initialize the X3D model for this object. */
	public final void initialize()
	{
            try { // catch-all
  x3dModel = new X3D().setProfile(X3D.PROFILE_IMMERSIVE).setVersion(X3D.VERSION_3_3)
  .setHead(new head()
    .addMeta(new meta().setName(meta.NAME_TITLE      ).setContent("WorldInfoExampleMetadataSetX3D3.x3d"))
    .addMeta(new meta().setName(meta.NAME_DESCRIPTION).setContent("This X3D3 scene contains MetadataSet with a non-null metadata field and multiple value nodes. Also provides a test target for python x3d package development, can x3d.py package generate this valid X3D file?"))
    .addMeta(new meta().setName(meta.NAME_INFO       ).setContent("Metadata nodes at root level of scene are not allowed in VRML97 or X3D3, but are allowed in X3D4."))
    .addMeta(new meta().setName(meta.NAME_INFO       ).setContent("Metadata node as WorldInfo metadata field are not allowed in VRML97, but are allowed in X3D3 or X3D4."))
    .addMeta(new meta().setName(meta.NAME_REFERENCE  ).setContent("WorldInfoExampleMetadataSetX3D4.x3d"))
    .addMeta(new meta().setName(meta.NAME_INFO       ).setContent("Original name MetadataSetWithMetadata.x3d"))
    .addMeta(new meta().setName(meta.NAME_CREATOR    ).setContent("Vincent Marchetti"))
    .addMeta(new meta().setName(meta.NAME_CREATOR    ).setContent("Don Brutzman"))
    .addMeta(new meta().setName(meta.NAME_CREATED    ).setContent("16 November 2021"))
    .addMeta(new meta().setName(meta.NAME_MODIFIED   ).setContent("7 April 2024"))
    .addMeta(new meta().setName(meta.NAME_SPECIFICATIONSECTION).setContent("X3D encodings, ISO/IEC 19776-1, Part 1: XML encoding, Annex B.6.1 x3d-4.0.xsd"))
    .addMeta(new meta().setName(meta.NAME_SPECIFICATIONURL).setContent("https://web3d.org/specifications/X3Dv4Draft/ISO-IEC19776-1v4.0-WD1/Part01/Schema.html#Version4.0Schema"))
    .addMeta(new meta().setName(meta.NAME_GENERATOR  ).setContent("X3D-Edit 4.0, https://www.web3d.org/x3d/tools/X3D-Edit"))
    .addMeta(new meta().setName(meta.NAME_IDENTIFIER ).setContent("https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter15Metadata/WorldInfoExampleMetadataSetX3D3.x3d"))
    .addMeta(new meta().setName(meta.NAME_LICENSE    ).setContent("https://creativecommons.org/licenses/by/4.0")))
  .setScene(new Scene()
    .addChild(new WorldInfo().setTitle("WorldInfoExampleMetadataSetX3D3.x3d Example Scene")
      .addComments(" WorldInfo single available child field of interest is 'metadata' and so contained MetadataSet must have containerField='metadata' which IS the default in X3D3 ")
      .setMetadata(new MetadataSet().setName("birthday").setReference("https://www.archives.gov/legislative/features/washington")
        .addComments(" Next field is 'metadata' and so contained MetadataString node must have containerField='metadata' which is default in X3D3, but not the default in X3D4 ")
        .setMetadata(new MetadataString().setName("calendar").setReference("this node describes nature of parent node, and is not intended as a data value").setValue(new String[] {"Julian"}))
        .addComments(" MetadataSet next fields of interest are 'value' and so contained Metadata nodes must have containerField='value' which is not the default in X3D3 but is the default in X3D4 ")
        .setMetadata(new MetadataString().setName("name").setValue(new String[] {"George","Washington"}))
        .setMetadata(new MetadataInteger().setName("day").setValue(new int[] {11}))
        .setMetadata(new MetadataInteger().setName("month").setValue(new int[] {2}))
        .setMetadata(new MetadataInteger().setName("year").setValue(new int[] {1731}))
        .setMetadata(new MetadataString().setName("birthplace").setValue(new String[] {"Popes Creek","Virginia"}))))
    .addChild(new Background().setSkyColor(new MFColor(new double[] {0.0,0.439216,0.760784})))
    .addChild(new Viewpoint().setDescription("View scene source to see metadata examples").setPosition(0.0,0.0,12.0))
    .addChild(new Anchor().setDescription("Load scene index page").setParameter(new String[] {"target=_blank"}).setUrl(new String[] {"WorldInfoExampleMetadataSetX3D3.html","https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter15Metadata/WorldInfoExampleMetadataSetX3D3.html"})
      .addChild(new Shape()
        .setGeometry(new Text().setString(new String[] {"View scene source","to see","WorldInfoExampleMetadataSetX3D3"})
          .setFontStyle(new FontStyle().setJustify(FontStyle.JUSTIFY_MIDDLE_MIDDLE).setSize(0.9).setSpacing(1.5)))
        .setAppearance(new Appearance()
          .setMaterial(new Material().setDiffuseColor(1.0,0.39216,0.992157))))));
            }
            catch (Exception ex)
            {       
                System.err.println ("*** Further hints on X3DJSAIL errors and exceptions at");
                System.err.println ("*** https://www.web3d.org/specifications/java/X3DJSAIL.html");
                throw (ex);
            }
	}
	// end of initialize() method

	/** The initialized model object, created within initialize() method. */
	private X3D x3dModel;

	/** 
	 * Provide a 
	 * <a href="https://dzone.com/articles/java-copy-shallow-vs-deep-in-which-you-will-swim" target="_blank">shallow copy</a>
	 * of the X3D model.
	 * @see <a href="https://www.web3d.org/specifications/java/javadoc/org/web3d/x3d/jsail/Core/X3D.html">X3D</a>
	 * @return WorldInfoExampleMetadataSetX3D3 model
	 */
	public X3D getX3dModel()
	{	  
		return x3dModel;
	}
	   
    /** 
     * Default main() method provided for test purposes, uses CommandLine to set global ConfigurationProperties for this object.
     * @param args array of input parameters, provided as arguments
     * @see <a href="https://www.web3d.org/specifications/java/javadoc/org/web3d/x3d/jsail/Core/X3D.html#handleArguments-java.lang.String:A-">X3D.handleArguments(args)</a>
     * @see <a href="https://www.web3d.org/specifications/java/javadoc/org/web3d/x3d/jsail/Core/X3D.html#validationReport--">X3D.validationReport()</a>
     * @see <a href="https://www.web3d.org/specifications/java/javadoc/org/web3d/x3d/jsail/CommandLine.html">CommandLine</a>
     * @see <a href="https://www.web3d.org/specifications/java/javadoc/org/web3d/x3d/jsail/CommandLine.html#USAGE">CommandLine.USAGE</a>
     * @see <a href="https://www.web3d.org/specifications/java/javadoc/org/web3d/x3d/jsail/ConfigurationProperties.html">ConfigurationProperties</a>
     */
    public static void main(String args[])
    {
        System.out.println("Build this X3D model, showing validation diagnostics...");
        X3D thisExampleX3dModel = new WorldInfoExampleMetadataSetX3D3().getX3dModel();
//      System.out.println("X3D model construction complete.");
	
        // next handle command line arguments
        boolean hasArguments = (args != null) && (args.length > 0);
        boolean validate = true; // default
        boolean argumentsLoadNewModel = false;
        String  fileName = new String();

        if (args != null)
        {
                for (String arg : args)
                {
                        if (arg.toLowerCase().startsWith("-v") || arg.toLowerCase().contains("validate"))
                        {
                                validate = true; // making sure
                        }
                        if (arg.toLowerCase().endsWith(X3D.FILE_EXTENSION_X3D) ||
                                arg.toLowerCase().endsWith(X3D.FILE_EXTENSION_CLASSICVRML) ||
                                arg.toLowerCase().endsWith(X3D.FILE_EXTENSION_X3DB) ||
                                arg.toLowerCase().endsWith(X3D.FILE_EXTENSION_VRML97) ||
                                arg.toLowerCase().endsWith(X3D.FILE_EXTENSION_EXI) ||
                                arg.toLowerCase().endsWith(X3D.FILE_EXTENSION_GZIP) ||
                                arg.toLowerCase().endsWith(X3D.FILE_EXTENSION_ZIP) ||
                                arg.toLowerCase().endsWith(X3D.FILE_EXTENSION_HTML) ||
                                arg.toLowerCase().endsWith(X3D.FILE_EXTENSION_XHTML))
                        {
                                argumentsLoadNewModel = true;
                                fileName = arg;
                        }
                }
        }
        if      (argumentsLoadNewModel)
                System.out.println("WARNING: \"X3dForWebAuthors.Chapter15Metadata.WorldInfoExampleMetadataSetX3D3\" model invocation is attempting to load file \"" + fileName + "\" instead of simply validating itself... file loading ignored.");
        else if (hasArguments) // if no arguments provided, this method produces usage warning
                thisExampleX3dModel.handleArguments(args);
	
        if (validate)
        {
            //  System.out.println("--- TODO fix duplicated outputs ---"); // omit when duplicated outputs problem is solved/refactored
		String validationResults = thisExampleX3dModel.validationReport();
            //  System.out.println("-----------------------------------"); // omit when duplicated outputs problem is solved/refactored
                System.out.print("X3dForWebAuthors.Chapter15Metadata.WorldInfoExampleMetadataSetX3D3 self-validation test confirmation: ");
                if (!validationResults.equals("success"))
                    System.out.println();
                System.out.println(validationResults.trim());

                // experimental: test X3DJSAIL output files
                // Chapter15Metadata/WorldInfoExampleMetadataSetX3D3_JavaExport.* file validation is checked when building X3D Example Archives
                String filenameX3D  = "Chapter15Metadata/WorldInfoExampleMetadataSetX3D3_JavaExport.x3d"; 
                String filenameX3DV = "Chapter15Metadata/WorldInfoExampleMetadataSetX3D3_JavaExport.x3dv"; 
                String filenameJSON = "Chapter15Metadata/WorldInfoExampleMetadataSetX3D3_JavaExport.json";
                thisExampleX3dModel.toFileX3D        (filenameX3D);
                thisExampleX3dModel.toFileClassicVRML(filenameX3DV);
// TODO         thisExampleX3dModel.toFileJSON       (filenameJSON);
        }
    }
}
