xml.schema/javahelp/org/netbeans/modules/xml/schema/tasks/retrievingxmlresources.html
author Milutin Kristofic <mkristofic@netbeans.org>
Tue, 31 Jan 2017 14:20:36 +0100
changeset 1584 ddcac47bfed1
parent 1241 f7c3471c4a3f
permissions -rw-r--r--
Added Missing license terms
samaresh@338
     1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
samaresh@338
     2
<!--
mkristofic@1584
     3
DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
mkristofic@1584
     4
mkristofic@1584
     5
Copyright 2009-2017 Oracle and/or its affiliates. All rights reserved.
mkristofic@1584
     6
mkristofic@1584
     7
Oracle and Java are registered trademarks of Oracle and/or its affiliates.
mkristofic@1584
     8
Other names may be trademarks of their respective owners.
mkristofic@1584
     9
mkristofic@1584
    10
The contents of this file are subject to the terms of either the GNU
mkristofic@1584
    11
General Public License Version 2 only ("GPL") or the Common
mkristofic@1584
    12
Development and Distribution License("CDDL") (collectively, the
mkristofic@1584
    13
"License"). You may not use this file except in compliance with the
mkristofic@1584
    14
License. You can obtain a copy of the License at
mkristofic@1584
    15
http://www.netbeans.org/cddl-gplv2.html
mkristofic@1584
    16
or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
mkristofic@1584
    17
specific language governing permissions and limitations under the
mkristofic@1584
    18
License.  When distributing the software, include this License Header
mkristofic@1584
    19
Notice in each file and include the License file at
mkristofic@1584
    20
nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
mkristofic@1584
    21
particular file as subject to the "Classpath" exception as provided
mkristofic@1584
    22
by Oracle in the GPL Version 2 section of the License file that
mkristofic@1584
    23
accompanied this code. If applicable, add the following below the
mkristofic@1584
    24
License Header, with the fields enclosed by brackets [] replaced by
mkristofic@1584
    25
your own identifying information:
mkristofic@1584
    26
"Portions Copyrighted [year] [name of copyright owner]"
mkristofic@1584
    27
mkristofic@1584
    28
Contributor(s):
mkristofic@1584
    29
mkristofic@1584
    30
The Original Software is NetBeans. The Initial Developer of the Original
mkristofic@1584
    31
Software is Sun Microsystems, Inc. Portions Copyright 2009-2010 Sun
mkristofic@1584
    32
Microsystems, Inc. All Rights Reserved.
mkristofic@1584
    33
mkristofic@1584
    34
If you wish your version of this file to be governed by only the CDDL
mkristofic@1584
    35
or only the GPL Version 2, indicate your decision by adding
mkristofic@1584
    36
"[Contributor] elects to include this software in this distribution
mkristofic@1584
    37
under the [CDDL or GPL Version 2] license." If you do not indicate a
mkristofic@1584
    38
single choice of license, a recipient has the option to distribute
mkristofic@1584
    39
your version of this file under either the CDDL, the GPL Version 2 or
mkristofic@1584
    40
to extend the choice of license to its licensees as provided above.
mkristofic@1584
    41
However, if you add GPL Version 2 code and therefore, elected the GPL
mkristofic@1584
    42
Version 2 license, then the option applies only if the new code is
mkristofic@1584
    43
made subject to such option by the copyright holder.
samaresh@338
    44
-->
samaresh@338
    45
<html>
samaresh@338
    46
<head>
psmejkal@1107
    47
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
samaresh@338
    48
<link rel="stylesheet" href="nbdocs://org.netbeans.modules.usersguide/org/netbeans/modules/usersguide/ide.css" type="text/css">
samaresh@338
    49
<title>Retrieving XML Resources</title>
samaresh@338
    50
</head>
samaresh@338
    51
<body>
samaresh@338
    52
<h2>Retrieving XML Resources</h2>
samaresh@338
    53
<p><small><a href="#seealso">See Also</a></small></p>
samaresh@338
    54
<p>You can use a wizard to retrieve external schema files into your IDE project. </p>
samaresh@338
    55
<p><b>To retrieve XML resources:</b></p>
samaresh@338
    56
<ol>
samaresh@338
    57
<li>In the IDE, create a new project or use an existing project.</li>
samaresh@338
    58
<li>If the Output window is not visible, choose Window&nbsp;&gt;&nbsp;Output.<br>
samaresh@338
    59
When the IDE retrieves the resources, informational messages appear in the Output window.</li>
samaresh@338
    60
<li>In the Projects window, right-click the <tt><i>project</i></tt> node and choose New&nbsp;&gt;&nbsp;File/Folder from the pop-up menu.</li>
samaresh@338
    61
<li>In the New File dialog box, under Categories, select the <tt>XML</tt> node, and in the File Types list, select <tt>External&nbsp;XML&nbsp;Schema&nbsp;Document</tt>.</li>
samaresh@338
    62
<li>Click Next.<br>
samaresh@338
    63
The New Retrieve Documents page opens.</li>
samaresh@338
    64
<li>Do one of the following:
samaresh@338
    65
<ul>
samaresh@338
    66
<li>To retrieve a schema file from a running web service, select the From URL radio button and specify the location of the file on the web.</li>
samaresh@338
    67
<li>To add a schema file stored in your local filesystem, select the From Local File System radio button and use the Browse button to navigate to and select the folder where the file resides on your local hard drive.<br>
samaresh@338
    68
Note that you must select the folder, not the file. If the folder contains several <tt>.xsd</tt> files, the IDE adds them all to your project.</li>
samaresh@338
    69
</ul></li>
samaresh@338
    70
<li>(Optional) Change the target location in the Save to Folder field for the retrieved resource.</li>
samaresh@338
    71
<li>To overwrite files with the same name in your project, select the Overwrite files with same name checkbox.</li>
samaresh@338
    72
<li>Click Finish.<br>
samaresh@338
    73
Notice the information that appears in the Output window. The IDE shows which files are being copied to project folders and if there are any errors, they appear in the Output window. Expand the <tt>Source&nbsp;Packages</tt> node of your project to see information about the schema file that you retrieved into your IDE project.</li>
samaresh@338
    74
</ol>
samaresh@338
    75
<ul class="note">
samaresh@338
    76
<li>If you added <tt>import</tt> or <tt>include</tt> statements using the Source view, or if you copied files with URL references into your project, the referenced schema may only be accessible through a URL. In this case, your project may not contain the true closure of all the documents. When the schemas are referenced, the IDE will perform the same logic that is used when retrieving XML resources using the External XML Schema Document wizard and transparently fetch the documents and store them in a non-version controlled area. This may cause a delay the first time these documents are accessed on your machine, because the referenced documents are not local. Subsequent accesses will be faster. If the URL points to an Internet resource, you may need to set up the correct proxy information in the IDE to ensure that the retriever process completes successfully (Tools &gt; Options &gt; General &gt; Proxy).</li>
samaresh@338
    77
</ul>
samaresh@338
    78
<dl>
samaresh@338
    79
<dt><a name="seealso">See Also</a></dt>
samaresh@338
    80
<dd><a href="../wiz/wiz_retrieveschemawsdl.html" title="New Retrieve Documents Wizard">New Retrieve Documents Wizard</a></dd>
samaresh@338
    81
<dd><a href="referencingextschemas.html" title="Referencing External Schemas">Referencing External Schemas</a></dd>
samaresh@338
    82
<dd><a href="../about.html" title="About XML Schema Tools">About XML Schema Tools</a></dd>
samaresh@338
    83
</dl>
samaresh@338
    84
<hr>
samaresh@338
    85
<small><a href="../credits.html">Legal Notices</a></small>
samaresh@338
    86
<table cellpadding="150" border="0"> 
samaresh@338
    87
<tr><td>&nbsp;</td></tr> 
samaresh@338
    88
<tr><td>&nbsp;</td></tr> 
samaresh@338
    89
<tr><td>&nbsp;</td></tr> 
samaresh@338
    90
</table> 
samaresh@338
    91
</body>
samaresh@338
    92
</html>