public class ImportConfig extends Object
Modifier and Type | Class and Description |
---|---|
static class |
ImportConfig.AnnotationListValue |
static class |
ImportConfig.BoolValue |
static class |
ImportConfig.DoubleArrayValue |
static class |
ImportConfig.FileValue |
static class |
ImportConfig.IntValue |
static class |
ImportConfig.LongValue |
static class |
ImportConfig.PassValue |
static class |
ImportConfig.StrValue |
static class |
ImportConfig.Value<T>
Container which thread-safely makes a generic configuration value
available, without requiring getters and setters.
|
static class |
ImportConfig.VersionInfo
Keys for fileset version information entries.
|
Constructor and Description |
---|
ImportConfig()
Simplest constructor which use calls
ImportConfig(File) with null. |
ImportConfig(File configFile)
Calls
ImportConfig(Preferences, IniFileLoader, Properties)
with user preferences, a local PreferenceContext , an
IniFileLoader initialized with the given argument, and
System.getProperties() . |
ImportConfig(Preferences prefs,
IniFileLoader ini,
Properties props)
Complete constructor.
|
Modifier and Type | Method and Description |
---|---|
boolean |
canLogin()
Confirm all information for login is supplied
|
void |
configureDebug(String levelString)
Modifies the logging level of everything under the
ome.formats , ome.services.blitz ,
ome.system and loci packages hierarchically. |
OMEROMetadataStoreClient |
createStore()
Create and return a new OMEROMetadataStoreClient
|
void |
fillVersionInfo(List<omero.model.NamedValue> versionInfo)
Note useful version information that can be extracted from this system,
as provenance that is useful for debugging.
|
String |
getAppTitle() |
String |
getBioFormatsVersion() |
boolean |
getCustomImageNaming() |
int |
getDebugLevel() |
String |
getFeedbackUrl() |
boolean |
getForceFileArchiveOn() |
String |
getForumUrl() |
String |
getHomeUrl() |
String |
getIniVersionNumber() |
String |
getLogFile() |
int |
getNumOfDirectories() |
String |
getOmeroVersion() |
boolean |
getStaticDisableHistory() |
ImportTarget |
getTarget() |
String |
getTokenUrl() |
Rectangle |
getUIBounds() |
String |
getUploaderUrl() |
boolean |
getUseQuaqua() |
boolean |
getUserDisableHistory() |
boolean |
getUserFullPath() |
String |
getUserSettingsDirectory() |
String |
getVersionNumber() |
boolean |
isUpgradeNeeded()
Check online to see if this is the current version
|
void |
loadAll()
Loads all the values for which it makes sense to have a preferences values.
|
void |
loadGui()
Loads gui specific values for which it makes sense to have a preferences values.
|
Map<String,String> |
map() |
protected <T> void |
prompt(ImportConfig.Value<T> value,
String prompt,
boolean hide)
Build prompt
|
void |
requestFromUser()
if can't log in request needed information
|
void |
saveAll() |
void |
saveGui()
Saves gui specific values for which it makes sense to have a preferences values.
|
void |
setCustomImageNaming(boolean b) |
void |
setDebugLevel(int level) |
void |
setNumOfDirectories(int i) |
void |
setUIBounds(Rectangle bounds) |
void |
setUseQuaqua(boolean b) |
void |
setUserDisableHistory(boolean b) |
void |
setUserFullPath(boolean b) |
void |
setVersionNumber(String s) |
protected List<ImportConfig.Value<?>> |
values() |
public static final String SERVER_NAME_SEPARATOR
public static final String READERS_KEY
System.getProperty(String)
. Should be the path of
a readers.txt file.public final ImportConfig.StrValue agent
public final ImportConfig.StrValue hostname
public final ImportConfig.StrValue username
public final ImportConfig.StrValue password
public final ImportConfig.IntValue port
public final ImportConfig.LongValue savedProject
public final ImportConfig.LongValue savedDataset
public final ImportConfig.LongValue savedScreen
public final ImportConfig.StrValue sessionKey
public final ImportConfig.LongValue group
public final ImportConfig.BoolValue doThumbnails
public final ImportConfig.BoolValue noStatsInfo
public final ImportConfig.StrValue email
public final ImportConfig.StrValue userSpecifiedName
public final ImportConfig.StrValue userSpecifiedDescription
@Deprecated public final ImportConfig.StrValue targetClass
@Deprecated public final ImportConfig.LongValue targetId
public final ImportConfig.StrValue target
public final ImportConfig.BoolValue debug
public final ImportConfig.BoolValue contOnError
public final ImportConfig.BoolValue sendReport
public final ImportConfig.BoolValue sendFiles
public final ImportConfig.BoolValue sendLogFile
public final ImportConfig.StrValue qaBaseURL
public final ImportConfig.BoolValue checkUpgrade
public final ImportConfig.BoolValue useCustomImageNaming
public final ImportConfig.BoolValue useFullPath
public final ImportConfig.IntValue numOfDirectories
public final ImportConfig.FileValue savedDirectory
public final ImportConfig.StrValue readersPath
public final ImportConfig.StrValue checksumAlgorithm
public final ImportConfig.BoolValue encryptedConnection
public final ImportConfig.BoolValue autoClose
public final ImportConfig.AnnotationListValue annotations
public final ImportConfig.DoubleArrayValue userPixels
public static final String DEFAULT_QABASEURL
public ImportConfig()
ImportConfig(File)
with null.public ImportConfig(File configFile)
ImportConfig(Preferences, IniFileLoader, Properties)
with user preferences, a local PreferenceContext
, an
IniFileLoader
initialized with the given argument, and
System.getProperties()
.configFile
- Can be null.public ImportConfig(Preferences prefs, IniFileLoader ini, Properties props)
prefs
- user and system preference and configuration dataini
- loads importer.ini
or other specified fileprops
- a Java properties object overriding other sources of preferences and configuration datapublic String getBioFormatsVersion()
public String getOmeroVersion()
public void fillVersionInfo(List<omero.model.NamedValue> versionInfo)
versionInfo
- the map into which version information is to be addedpublic void configureDebug(String levelString)
ome.formats
, ome.services.blitz
,
ome.system
and loci
packages hierarchically.levelString
- the level to set or, if null
, then the
initial debug level is used as before having been changed.public OMEROMetadataStoreClient createStore() throws Exception
Exception
- if the creation failedpublic boolean isUpgradeNeeded()
public boolean canLogin()
public String getLogFile()
public String getHomeUrl()
public String getForumUrl()
public String getAppTitle()
public boolean getForceFileArchiveOn()
public boolean getStaticDisableHistory()
public boolean getUserDisableHistory()
public void setUserDisableHistory(boolean b)
b
- - true if Quaqua should be usedpublic String getVersionNumber()
public void setVersionNumber(String s)
public String getIniVersionNumber()
public String getUserSettingsDirectory()
public boolean getUseQuaqua()
public void setUseQuaqua(boolean b)
b
- - true if Quaqua should be usedpublic void setDebugLevel(int level)
level
- - default debug levelpublic int getDebugLevel()
public Rectangle getUIBounds()
public void setUIBounds(Rectangle bounds)
bounds
- - set UI bounds for application windowpublic String getFeedbackUrl()
public String getTokenUrl()
public String getUploaderUrl()
public boolean getUserFullPath()
public void setUserFullPath(boolean b)
b
- ini user full pathpublic boolean getCustomImageNaming()
public void setCustomImageNaming(boolean b)
b
- custom image namingpublic int getNumOfDirectories()
public void setNumOfDirectories(int i)
i
- number of directoriesprotected <T> void prompt(ImportConfig.Value<T> value, String prompt, boolean hide)
T
- the kind of value contained by the "value" argumentvalue
- the valueprompt
- the prompthide
- use *
s for characterspublic void requestFromUser()
protected List<ImportConfig.Value<?>> values()
public void loadGui()
saveAll()
public void saveGui()
saveAll()
public void loadAll()
saveAll()
public void saveAll()
loadAll()
public ImportTarget getTarget()
Version: 5.3.5-ice35-b73
Copyright © 2017 The University of Dundee & Open Microscopy Environment. All Rights Reserved.