public class PublishConfigurator
extends java.lang.Object
implements java.io.Serializable
Modifier and Type | Method and Description |
---|---|
void |
addOutputModule(IPublishOutputModule module)
Adds an output modules to this configurators list of output modules.
|
void |
addSelectedTaxonNodeElements(org.jdom.Element selectedTaxonNodeElement)
Add a taxon node element to list of taxon nodes that will be processed by
the print publisher.
|
int |
calculateNumberOfNodes()
FIXME this is a dummy implementation
|
ICdmRepository |
getApplicationConfiguration()
The application controller
associated with this instance
|
java.io.File |
getExportFolder()
The folder, the produced output will be written to.
|
IXMLEntityFactory |
getFactory()
Returns a
RemoteXMLEntityFactory if this is a remote
instance or a LocalXMLEntityFactory if this is a
local instance |
java.util.UUID |
getFeatureTreeUuid()
The feature tree configures which features and in which order and nesting
will be exported by the application
|
java.util.List<IPublishOutputModule> |
getOutputModules()
Returns a list of output modules.
|
IProgressMonitor |
getProgressMonitor() |
java.util.List<org.jdom.Element> |
getSelectedTaxonNodeElements()
Returns a list of taxon node elements that should be processed by the
print publisher.
|
java.net.URL |
getWebserviceUrl()
Returns the CDM Community Stores access point connected to this
configuration.
|
boolean |
isDoDescriptions()
Whether to export descriptions.
|
boolean |
isDoImages()
Whether to export images
|
boolean |
isDoPolytomousKey() |
boolean |
isDoPublishEntireBranches()
Whether taxonomically included taxa for the
selected taxon nodes should
be exported recursively.
|
boolean |
isDoSynonymy()
Whether the synonymy should be exported.
|
boolean |
isLocal()
Whether this configurator is connected to a local application controller.
|
boolean |
isRemote()
Whether this configurator is connected to a remote CDM Community Store
|
static PublishConfigurator |
NewLocalInstance(ICdmRepository applicationConfiguration)
Creates a new instance connected to the given application controller.
|
static PublishConfigurator |
NewRemoteInstance()
Creates a new instance, ready to be connected to a CDM Community Stores
access point.
|
void |
setDoDescriptions(boolean doDescriptions) |
void |
setDoImages(boolean doImages) |
void |
setDoPolytomousKey(boolean doPolytomousKey) |
void |
setDoPublishEntireBranches(boolean doPublishEntireBranches) |
void |
setDoSynonymy(boolean selection) |
void |
setExportFolder(java.io.File exportFolder) |
void |
setFeatureTree(java.util.UUID featureTreeUuid) |
void |
setOutputModules(java.util.List<IPublishOutputModule> outputModules) |
void |
setProgressMonitor(IProgressMonitor progressMonitor) |
void |
setSelectedTaxonNodeElements(java.util.List<org.jdom.Element> selectedTaxonNodeElements)
Set the list of taxon node elements that should be processed by the print
publisher.
|
void |
setWebserviceUrl(java.lang.String webserviceUrlString) |
void |
setWebserviceUrl(java.net.URL webserviceUrl) |
public static PublishConfigurator NewLocalInstance(ICdmRepository applicationConfiguration)
applicationConfiguration
- public static PublishConfigurator NewRemoteInstance()
public java.net.URL getWebserviceUrl()
public void setWebserviceUrl(java.lang.String webserviceUrlString) throws java.net.MalformedURLException
webserviceUrlString
- java.net.MalformedURLException
#getWebserviceUrl()}
public void setWebserviceUrl(java.net.URL webserviceUrl)
webserviceUrl
- #getWebserviceUrl()}
public java.util.List<org.jdom.Element> getSelectedTaxonNodeElements()
public void setSelectedTaxonNodeElements(java.util.List<org.jdom.Element> selectedTaxonNodeElements)
selectedTaxonNodeElements
- #getSelectedTaxonNodeElements()}
public void addSelectedTaxonNodeElements(org.jdom.Element selectedTaxonNodeElement)
selectedTaxonNodeElement
- #getSelectedTaxonNodeElements()}
public boolean isDoDescriptions()
public void setDoDescriptions(boolean doDescriptions)
doDescriptions
- #isDoDescriptions()}
public boolean isDoImages()
public void setDoImages(boolean doImages)
doImages
- #isDoImages()}
public java.io.File getExportFolder()
public void setExportFolder(java.io.File exportFolder)
exportFolder
- the exportFile to set#getExportFolder()}
public java.util.List<IPublishOutputModule> getOutputModules()
IPublishOutputModule} and implementations thereof
public void setOutputModules(java.util.List<IPublishOutputModule> outputModules)
outputModules
- the outputModules to set#getOutputModules()}
public void addOutputModule(IPublishOutputModule module)
module
- IPublishOutputModule} and implementations thereof
public boolean isRemote()
public boolean isLocal()
public IXMLEntityFactory getFactory()
RemoteXMLEntityFactory
if this
is a remote
instance or a LocalXMLEntityFactory
if this
is a
local instanceIXMLEntityFactory
public int calculateNumberOfNodes()
public boolean isDoPublishEntireBranches()
true
if this is desiredpublic void setDoPublishEntireBranches(boolean doPublishEntireBranches)
doPublishEntireBranches
- #isDoPublishEntireBranches()}
public boolean isDoSynonymy()
true
if this is desiredpublic void setDoSynonymy(boolean selection)
selection
- #isDoSynonymy()}
public ICdmRepository getApplicationConfiguration()
CdmApplicationController
or null if this
is a remote instancepublic java.util.UUID getFeatureTreeUuid()
public void setFeatureTree(java.util.UUID featureTreeUuid)
featureTreeUuid
- the featureTree to set#getFeatureTreeUuid()}
public void setProgressMonitor(IProgressMonitor progressMonitor)
public IProgressMonitor getProgressMonitor()
public boolean isDoPolytomousKey()
public void setDoPolytomousKey(boolean doPolytomousKey)
doPolytomousKey
- the doPolytomousKey to setCopyright © 2007-2020 EDIT. All Rights Reserved.