com.mulesoft.tools.migration.project.model

Class ApplicationModel

java.lang.Object

com.mulesoft.tools.migration.project.model.ApplicationModel

public class ApplicationModel
extends Object

Represent the application to be migrated

Since:

1.0.0

Author:

Mulesoft Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApplicationModel.ApplicationModelBuilder It represent the builder to obtain a ApplicationModel

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ApplicationModel(Map<Path,org.jdom2.Document> applicationDocuments)
protected	ApplicationModel(Map<Path,org.jdom2.Document> applicationDocuments, Map<Path,org.jdom2.Document> domainDocuments)

Method Summary

Modifier and Type	Method and Description
static void	addNameSpace(org.jdom2.Namespace namespace, String schemaLocation, org.jdom2.Document document) Adds a namespace to an application document
void	addNameSpace(String prefix, String uri, String schemaLocation) Adds a namespace to the application documents
Map<Path,org.jdom2.Document>	getApplicationDocuments() The key of the map is relative to the source of the target project.
Map<Path,org.jdom2.Document>	getDomainDocuments() The key of the map is relative to the source of the target project.
static List<org.jdom2.Element>	getElementsWithNamespace(org.jdom2.Document document, org.jdom2.Namespace namespace, ApplicationModel applicationModel) Retrieves all elements in the document that have the specified namespace
Optional<MuleArtifactJsonModel>	getMuleArtifactJsonModel() Retrieves the MuleArtifactJsonModel.
String	getMuleVersion()
org.jdom2.Element	getNode(String xpathExpression) Returns a single node in the application documents that match the xpath expression
Optional<org.jdom2.Element>	getNodeOptional(String xpathExpression) Returns a single node in the application documents that match the xpath expression
List<org.jdom2.Element>	getNodes(String xpathExpression) Returns all the nodes in the application documents that match the xpath expression
List<org.jdom2.Element>	getNodes(org.jdom2.xpath.XPathExpression xpathExpression) Returns all the nodes in the application documents that match the xpath expression
Optional<PomModel>	getPomModel() Retrieves the PomModel of this instance.
Path	getProjectBasePath() Retrieves the root path of the project represented by the application model instance
ProjectType	getProjectType()
Path	getSourceProjectBasePath() Retrieves the root path of the project represented by the application model instance
List<org.jdom2.Namespace>	getSupportedNamespaces() Retrieves the List.
void	removeNameSpace(org.jdom2.Namespace namespace, String schemaLocation, org.jdom2.Document document) Removes a namespace from an application document
void	removeNameSpace(String prefix, String uri, String schemaLocation) Removes a namespace from the application documents
void	setMuleVersion(String muleVersion)
void	setProjectType(ProjectType projectType)
void	setSupportedNamespaces(List<org.jdom2.Namespace> supportedNamespaces) Sets the List that represents the supported namespaces for the tool.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationModel

protected ApplicationModel(Map<Path,org.jdom2.Document> applicationDocuments)

ApplicationModel

protected ApplicationModel(Map<Path,org.jdom2.Document> applicationDocuments,
                           Map<Path,org.jdom2.Document> domainDocuments)

Method Detail

getApplicationDocuments

public Map<Path,org.jdom2.Document> getApplicationDocuments()

The key of the map is relative to the source of the target project.

getDomainDocuments

public Map<Path,org.jdom2.Document> getDomainDocuments()

The key of the map is relative to the source of the target project.

This is just for the domain referenced by an application, this is not used when migrating the domain itself.

getNodes

public List<org.jdom2.Element> getNodes(String xpathExpression)

Returns all the nodes in the application documents that match the xpath expression

Parameters:

xpathExpression - the xpath expression that defines which nodes should be retrieved

Returns:

all the nodes that match the xpath expression

getNode

public org.jdom2.Element getNode(String xpathExpression)

Returns a single node in the application documents that match the xpath expression

Parameters:

xpathExpression - the xpath expression that defines which nodes should be retrieved

Returns:

all the nodes that match the xpath expression

getNodeOptional

public Optional<org.jdom2.Element> getNodeOptional(String xpathExpression)

Returns a single node in the application documents that match the xpath expression

Parameters:

xpathExpression - the xpath expression that defines which nodes should be retrieved

Returns:

all the nodes that match the xpath expression

getNodes

public List<org.jdom2.Element> getNodes(org.jdom2.xpath.XPathExpression xpathExpression)

Returns all the nodes in the application documents that match the xpath expression

Parameters:

xpathExpression - the xpath expression that defines which nodes should be retrieved

Returns:

all the nodes that match the xpath expression

getElementsWithNamespace

public static List<org.jdom2.Element> getElementsWithNamespace(org.jdom2.Document document,
                                                               org.jdom2.Namespace namespace,
                                                               ApplicationModel applicationModel)

Retrieves all elements in the document that have the specified namespace

Parameters:

document - the document where the elements are going to be searched through

namespace - the namespace of the elements that should be retrieved

Returns:

a list of elements within the document that have that namespace

addNameSpace

public void addNameSpace(String prefix,
                         String uri,
                         String schemaLocation)

Adds a namespace to the application documents

Parameters:

prefix -

uri -

schemaLocation -

addNameSpace

public static void addNameSpace(org.jdom2.Namespace namespace,
                                String schemaLocation,
                                org.jdom2.Document document)

Adds a namespace to an application document

Parameters:

namespace -

schemaLocation -

document -

removeNameSpace

public void removeNameSpace(String prefix,
                            String uri,
                            String schemaLocation)

Removes a namespace from the application documents

Parameters:

prefix -

uri -

schemaLocation -

removeNameSpace

public void removeNameSpace(org.jdom2.Namespace namespace,
                            String schemaLocation,
                            org.jdom2.Document document)

Removes a namespace from an application document

Parameters:

namespace -

schemaLocation -

document -

getPomModel

public Optional<PomModel> getPomModel()

Retrieves the PomModel of this instance. It is optional since the pom is not mandatory in a Mule 3.x application

Returns:

tan optional PomModel

setProjectType

public void setProjectType(ProjectType projectType)

getProjectType

public ProjectType getProjectType()

setMuleVersion

public void setMuleVersion(String muleVersion)

getMuleVersion

public String getMuleVersion()

getSourceProjectBasePath

public Path getSourceProjectBasePath()

Retrieves the root path of the project represented by the application model instance

getProjectBasePath

public Path getProjectBasePath()

Retrieves the root path of the project represented by the application model instance

getMuleArtifactJsonModel

public Optional<MuleArtifactJsonModel> getMuleArtifactJsonModel()

Retrieves the MuleArtifactJsonModel. It is optional since this resource is not part of a Mule 3.x application

Returns:

an optional MuleArtifactJsonModel

setSupportedNamespaces

public void setSupportedNamespaces(List<org.jdom2.Namespace> supportedNamespaces)

Sets the List that represents the supported namespaces for the tool.

Parameters:

supportedNamespaces -

getSupportedNamespaces

public List<org.jdom2.Namespace> getSupportedNamespaces()

Retrieves the List.

Returns:

an optional List