public abstract class Query extends DocGenElement implements Generatable
This class should be extended if writing java extensions, or any of its subclass like Table
Modifier and Type | Field and Description |
---|---|
protected static java.util.HashSet<java.lang.reflect.Field> |
notToStringSet |
protected boolean |
sortElementsByName |
protected java.util.List<java.lang.Object> |
targets
The elements passed into this query.
|
protected java.util.List<java.lang.String> |
titles |
dgElement, ignore, loop, titlePrefix, titleSuffix, useContextNameAsTitle
Constructor and Description |
---|
Query() |
Modifier and Type | Method and Description |
---|---|
void |
accept(IModelVisitor visitor) |
java.util.List<com.nomagic.magicdraw.actions.MDAction> |
getActions()
These actions will show up as menu items under View Interaction, if the
user right clicks on a view that will execute this query
|
java.util.List<java.lang.Object> |
getTargets() |
java.util.List<java.lang.String> |
getTitles() |
void |
initialize()
This is called after the query object has been constructed and the
targets and dgElement fields are set
|
boolean |
isSortElementsByName() |
protected java.util.Set<java.lang.reflect.Field> |
notToString() |
void |
parse()
This is called after initialize
|
void |
setSortElementsByName(boolean sortElementsByName) |
void |
setTargets(java.util.List<java.lang.Object> t) |
void |
setTitles(java.util.List<java.lang.String> t) |
java.lang.String |
toStringStart() |
java.util.List<DocumentElement> |
visit(boolean forViewEditor,
java.lang.String outputDir)
This method must be overidden by subclasses to return the result of the
query
|
getDgElement, getIgnore, getLoop, getTitlePrefix, getTitleSuffix, getUseContextNameAsTitle, setDgElement, setIgnore, setLoop, setTitlePrefix, setTitleSuffix, setUseContextNameAsTitle, toString, toStringEnd
protected java.util.List<java.lang.Object> targets
protected java.util.List<java.lang.String> titles
protected boolean sortElementsByName
protected static java.util.HashSet<java.lang.reflect.Field> notToStringSet
public void setTargets(java.util.List<java.lang.Object> t)
public java.util.List<java.lang.Object> getTargets()
public void setTitles(java.util.List<java.lang.String> t)
public java.util.List<java.lang.String> getTitles()
public boolean isSortElementsByName()
public void setSortElementsByName(boolean sortElementsByName)
public void initialize()
initialize
in interface Generatable
public java.util.List<DocumentElement> visit(boolean forViewEditor, java.lang.String outputDir)
visit
in interface Generatable
public void parse()
parse
in interface Generatable
public java.util.List<com.nomagic.magicdraw.actions.MDAction> getActions()
These actions will show up as menu items under View Interaction, if the user right clicks on a view that will execute this query
targets and dgElement would have been filled
getActions
in interface Generatable
public void accept(IModelVisitor visitor)
accept
in interface IDocGenElement
protected java.util.Set<java.lang.reflect.Field> notToString()
public java.lang.String toStringStart()
toStringStart
in class DocGenElement