com.esri.gpt.catalog.gxe
Class GxeFile

java.lang.Object
  com.esri.gpt.catalog.gxe.GxeFile

public class GxeFile
extends Object

A component XML file associated with a Geoportal XML editor definition.

Constructor Summary

GxeFile()
Default constructor

GxeFile(GxeFile parent, String location)
Constructs with a parent file and reference location.

Method Summary

Node	findRoot(Document dom) Finds the root node within a document.
List<URI>	getBaseLocations() Gets the base locations.
boolean	getIsRoot() Indicates whether or not the file is the definition root.
String	getLocation() Gets the location.
GxeFile	getParent() Gets the parent.
URL	getReferencedUrl() Gets the URL that was referenced while loading the DOM.
Document	loadDom() Loads the XML document object model (org.w3c.dom.Document).
URL	makeUrl() Returns the URL for the file.
void	setBaseLocations(List<URI> locations) Sets the base locations.
void	setIsRoot(boolean isRoot) Indicates whether or not the file is the definition root.
void	setLocation(String location) Sets the location.
void	setParent(GxeFile parent) Sets the parent.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GxeFile

public GxeFile()

Default constructor

GxeFile

public GxeFile(GxeFile parent,
               String location)

Constructs with a parent file and reference location.

Parameters:

parent - the parent file from which this external reference was made

location - the file location

Method Detail

getBaseLocations

public List<URI> getBaseLocations()

Gets the base locations.

Returns:

the base locations

setBaseLocations

public void setBaseLocations(List<URI> locations)

Sets the base locations.

Parameters:

locations - the base locations

getIsRoot

public boolean getIsRoot()

Indicates whether or not the file is the definition root.

Returns:

true if this is the root

setIsRoot

public void setIsRoot(boolean isRoot)

Indicates whether or not the file is the definition root.

Parameters:

isRoot - true if this is the root

getLocation

public String getLocation()

Gets the location.

Returns:

the location

setLocation

public void setLocation(String location)

Sets the location.

Parameters:

location - the location

getParent

public GxeFile getParent()

Gets the parent.

Returns:

the parent

setParent

public void setParent(GxeFile parent)

Sets the parent.

Parameters:

parent - the parent

getReferencedUrl

public URL getReferencedUrl()

Gets the URL that was referenced while loading the DOM.

Returns:

the referenced URL

findRoot

public Node findRoot(Document dom)

Finds the root node within a document.

Parameters:

dom - the document

Returns:

the root node

loadDom

public Document loadDom()

Loads the XML document object model (org.w3c.dom.Document).

Throws:

Exception - if an exception occurs

makeUrl

public URL makeUrl()
            throws Exception

Returns the URL for the file.

Returns:

the associated url

Throws:

IOException - if the URL cannot be generated

Exception