Package net.ssehub.easy.instantiation.python.codeArtifacts

Class PythonCodeImport

java.lang.Object

net.ssehub.easy.instantiation.python.codeArtifacts.PythonCodeImport

All Implemented Interfaces:

net.ssehub.easy.instantiation.core.model.vilTypes.IStringValueProvider, net.ssehub.easy.instantiation.core.model.vilTypes.IVilType, IPythonCodeElement, IPythonCodeImport, Storable

public class PythonCodeImport
extends Object
implements IPythonCodeImport

Represents a Python "import" in VTL.

Author:

Kevin Schaperjahn

Nested Class Summary

Nested classes/interfaces inherited from interface net.ssehub.easy.instantiation.core.model.vilTypes.IStringValueProvider

net.ssehub.easy.instantiation.core.model.vilTypes.IStringValueProvider.StringComparator

Field Summary

Fields

Modifier and Type	Field	Description
private String	alias
private IPythonCodeArtifact	artifact
private boolean	isWildcard
private String	module
private List<String>	names

Fields inherited from interface net.ssehub.easy.instantiation.python.codeArtifacts.IPythonCodeElement

KEY_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
PythonCodeImport(IPythonCodeArtifact artifact, String module, boolean explicit)
PythonCodeImport(IPythonCodeArtifact artifact, String module, String name, boolean explicit)

Method Summary

Modifier and Type	Method	Description
PythonCodeImport	addName(String name)	Adds a further name to be imported.
String	getAlias()
IPythonCodeArtifact	getArtifact()
String	getModule()
String	getName()
IPythonCodeElement	getParent()
String	getTracerStringValue(net.ssehub.easy.instantiation.core.model.vilTypes.IStringValueProvider.StringComparator comparator)
private boolean	hasName(String name)
boolean	isWildcard()
boolean	match(IPythonCodeImport other)
PythonCodeImport	setAlias(String alias)
void	setParent(IPythonCodeElement parent)
void	store(net.ssehub.easy.instantiation.core.model.templateModel.CodeWriter out)
PythonCodeImport	toImports()	Moves this import to the imports at the beginning of the artifact.
PythonCodeImport	toImports(boolean apply)	Moves this import conditionally to the imports at the beginning of the artifact.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.ssehub.easy.instantiation.python.codeArtifacts.IPythonCodeElement

addAll, getSortKey, getStringValue, getTopClass, hasPythondocComment, isAttribute, isBlock, isClass, isEmptyLine, moveToAttributes, moveToImports

Methods inherited from interface net.ssehub.easy.instantiation.python.codeArtifacts.Storable

getElementCount, toCode

Field Details

module

private String module

names

private List<String> names

alias

private String alias

artifact

private IPythonCodeArtifact artifact

isWildcard

private boolean isWildcard

Constructor Details

PythonCodeImport

public PythonCodeImport(IPythonCodeArtifact artifact,
 String module,
 boolean explicit)

PythonCodeImport

public PythonCodeImport(IPythonCodeArtifact artifact,
 String module,
 String name,
 boolean explicit)

Method Details

getAlias

public String getAlias()

Specified by:

getAlias in interface IPythonCodeImport

toImports

public PythonCodeImport toImports()

Moves this import to the imports at the beginning of the artifact. By default, the import occurs wherever it is added.

Returns:

this for chaining

toImports

public PythonCodeImport toImports(boolean apply)

Moves this import conditionally to the imports at the beginning of the artifact. By default, the import occurs wherever it is added.

Parameters:

apply - whether this import shall be moved or not

Returns:

this for chaining

setAlias

public PythonCodeImport setAlias(String alias)

store

public void store(net.ssehub.easy.instantiation.core.model.templateModel.CodeWriter out)

Specified by:

store in interface Storable

getName

public String getName()

Specified by:

getName in interface IPythonCodeImport

getModule

public String getModule()

Specified by:

getModule in interface IPythonCodeImport

getTracerStringValue

public String getTracerStringValue(net.ssehub.easy.instantiation.core.model.vilTypes.IStringValueProvider.StringComparator comparator)

Specified by:

getTracerStringValue in interface IPythonCodeElement

isWildcard

public boolean isWildcard()

Specified by:

isWildcard in interface IPythonCodeImport

getArtifact

public IPythonCodeArtifact getArtifact()

Specified by:

getArtifact in interface IPythonCodeElement

getParent

public IPythonCodeElement getParent()

Specified by:

getParent in interface IPythonCodeElement

setParent

public void setParent(IPythonCodeElement parent)

Specified by:

setParent in interface IPythonCodeElement

match

public boolean match(IPythonCodeImport other)

Specified by:

match in interface IPythonCodeImport

hasName

private boolean hasName(String name)

addName

public PythonCodeImport addName(String name)

Adds a further name to be imported.

Parameters:

name - the name

Returns:

this for chaining