org.openpnp.model

Class Configuration

java.lang.Object

org.openpnp.model.AbstractModelObject

org.openpnp.model.Configuration

public class Configuration
extends AbstractModelObject

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Configuration.MachineConfigurationHolder Used to provide a fixed root for the Machine when serializing.
static class	Configuration.PackagesConfigurationHolder Used to provide a fixed root for the Packages when serializing.
static class	Configuration.PartsConfigurationHolder Used to provide a fixed root for the Parts when serializing.
static class	Configuration.TablesLinked
static class	Configuration.VisionSettingsConfigurationHolder Used to provide a fixed root for the VisionSettings when serializing.

Field Summary

Fields inherited from class org.openpnp.model.AbstractModelObject

propertyChangeSupport

Method Summary

Modifier and Type	Method and Description
void	addListener(ConfigurationListener listener)
void	addPackage(Package pkg)
void	addPart(Part part)
void	addVisionSettings(AbstractVisionSettings visionSettings)
protected java.io.File	createBackedUpFile(java.lang.String fileName, java.time.LocalDateTime now)
static java.lang.String	createId(java.lang.String prefix)
java.io.File	createResourceFile(java.lang.Class forClass, java.lang.String prefix, java.lang.String suffix) Creates a new file with a unique name within the configuration directory.
static Serializer	createSerializer()
void	fireVisionSettingsChanged() Signal that something about the vision settings has changed.
static Configuration	get()
Board	getBoard(java.io.File file)
java.util.List<Board>	getBoards()
EventBus	getBus()
java.io.File	getConfigurationDirectory()
ThemeSettingsPanel.FontSize	getFontSize()
java.lang.String	getImgurClientId()
java.lang.String	getLengthDisplayFormat()
java.lang.String	getLengthDisplayFormatWithUnits()
java.util.Locale	getLocale()
Machine	getMachine()
Package	getPackage(java.lang.String id)
java.util.List<Package>	getPackages()
Part	getPart(java.lang.String id)
java.util.List<Part>	getParts()
java.io.File	getResourceDirectory(java.lang.Class forClass) Gets a File reference for the resources directory belonging to the given class.
java.io.File	getResourceFile(java.lang.Class forClass, java.lang.String name) Gets a File reference for the named file within the configuration directory.
Scripting	getScripting()
LengthUnit	getSystemUnits()
Configuration.TablesLinked	getTablesLinked()
ThemeInfo	getThemeInfo()
int	getVerticalScrollUnitIncrement()
java.util.List<AbstractVisionSettings>	getVisionSettings()
AbstractVisionSettings	getVisionSettings(java.lang.String visionSettingsId)
static void	initialize() Initializes a new temporary Configuration singleton storing configuration in memory only.
static void	initialize(java.io.File configurationDirectory) Initializes a new persistent Configuration singleton storing configuration files in configurationDirectory.
java.lang.Boolean	isAlternateRows()
static boolean	isInstanceInitialized()
void	load()
Job	loadJob(java.io.File file)
void	removeListener(ConfigurationListener listener)
void	removePackage(Package pkg)
void	removePart(Part part)
void	removeVisionSettings(AbstractVisionSettings visionSettings)
void	save()
void	saveBoard(Board board)
void	saveJob(Job job, java.io.File file)
void	setAlternateRows(java.lang.Boolean alternateRows)
void	setFontSize(ThemeSettingsPanel.FontSize fontSize)
void	setLengthDisplayFormat(java.lang.String format)
void	setLengthDisplayFormatWithUnits(java.lang.String format)
void	setLocale(java.util.Locale locale)
void	setMachine(Machine machine)
void	setSystemUnits(LengthUnit lengthUnit)
void	setTablesLinked(Configuration.TablesLinked tablesLinked)
void	setThemeInfo(ThemeInfo theme)
void	setVerticalScrollUnitIncrement(int verticalScrollUnitIncrement)

Methods inherited from class org.openpnp.model.AbstractModelObject

addPropertyChangeListener, addPropertyChangeListener, fireIndexedPropertyChange, firePropertyChange, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Method Detail

isInstanceInitialized

public static boolean isInstanceInitialized()

get

public static Configuration get()

initialize

public static void initialize(java.io.File configurationDirectory)

Initializes a new persistent Configuration singleton storing configuration files in configurationDirectory.

Parameters:

configurationDirectory -

initialize

public static void initialize()

Initializes a new temporary Configuration singleton storing configuration in memory only.

Parameters:

configurationDirectory -

setMachine

public void setMachine(Machine machine)

getScripting

public Scripting getScripting()

getBus

public EventBus getBus()

getConfigurationDirectory

public java.io.File getConfigurationDirectory()

getSystemUnits

public LengthUnit getSystemUnits()

setSystemUnits

public void setSystemUnits(LengthUnit lengthUnit)

getTablesLinked

public Configuration.TablesLinked getTablesLinked()

setTablesLinked

public void setTablesLinked(Configuration.TablesLinked tablesLinked)

getLocale

public java.util.Locale getLocale()

setLocale

public void setLocale(java.util.Locale locale)

getThemeInfo

public ThemeInfo getThemeInfo()

setThemeInfo

public void setThemeInfo(ThemeInfo theme)

getFontSize

public ThemeSettingsPanel.FontSize getFontSize()

setFontSize

public void setFontSize(ThemeSettingsPanel.FontSize fontSize)

isAlternateRows

public java.lang.Boolean isAlternateRows()

setAlternateRows

public void setAlternateRows(java.lang.Boolean alternateRows)

getLengthDisplayFormat

public java.lang.String getLengthDisplayFormat()

setLengthDisplayFormat

public void setLengthDisplayFormat(java.lang.String format)

getLengthDisplayFormatWithUnits

public java.lang.String getLengthDisplayFormatWithUnits()

setLengthDisplayFormatWithUnits

public void setLengthDisplayFormatWithUnits(java.lang.String format)

getVerticalScrollUnitIncrement

public int getVerticalScrollUnitIncrement()

setVerticalScrollUnitIncrement

public void setVerticalScrollUnitIncrement(int verticalScrollUnitIncrement)

getResourceDirectory

public java.io.File getResourceDirectory(java.lang.Class forClass)
                                  throws java.io.IOException

Gets a File reference for the resources directory belonging to the given class. The directory is guaranteed to exist.

Parameters:

forClass -

Returns:

Throws:

java.io.IOException

getResourceFile

public java.io.File getResourceFile(java.lang.Class forClass,
                                    java.lang.String name)
                             throws java.io.IOException

Gets a File reference for the named file within the configuration directory. forClass is used to uniquely identify the file and keep it separate from other classes' files.

Parameters:

forClass -

name -

Returns:

Throws:

java.io.IOException

createResourceFile

public java.io.File createResourceFile(java.lang.Class forClass,
                                       java.lang.String prefix,
                                       java.lang.String suffix)
                                throws java.io.IOException

Creates a new file with a unique name within the configuration directory. forClass is used to uniquely identify the file within the application and a unique name is generated within that namespace. suffix is appended to the unique part of the filename. The result of calling File.getName() on the returned file can be used to load the same file in the future by calling getResourceFile(). This method uses NanosecondTime.get() so the files names will be unique and ordered.

Parameters:

forClass -

suffix -

Returns:

Throws:

java.io.IOException

addListener

public void addListener(ConfigurationListener listener)

removeListener

public void removeListener(ConfigurationListener listener)

load

public void load()
          throws java.lang.Exception

Throws:

java.lang.Exception

save

public void save()
          throws java.lang.Exception

Throws:

java.lang.Exception

createBackedUpFile

protected java.io.File createBackedUpFile(java.lang.String fileName,
                                          java.time.LocalDateTime now)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getPackage

public Package getPackage(java.lang.String id)

getPackages

public java.util.List<Package> getPackages()

addPackage

public void addPackage(Package pkg)

removePackage

public void removePackage(Package pkg)

getPart

public Part getPart(java.lang.String id)

getParts

public java.util.List<Part> getParts()

addPart

public void addPart(Part part)

removePart

public void removePart(Part part)

addVisionSettings

public void addVisionSettings(AbstractVisionSettings visionSettings)

getVisionSettings

public java.util.List<AbstractVisionSettings> getVisionSettings()

getVisionSettings

public AbstractVisionSettings getVisionSettings(java.lang.String visionSettingsId)

removeVisionSettings

public void removeVisionSettings(AbstractVisionSettings visionSettings)

getBoards

public java.util.List<Board> getBoards()

fireVisionSettingsChanged

public void fireVisionSettingsChanged()

Signal that something about the vision settings has changed. Inheritance makes it hard to track how changes affect single properties, therefore this is simply fired globally.

getMachine

public Machine getMachine()

getBoard

public Board getBoard(java.io.File file)
               throws java.lang.Exception

Throws:

java.lang.Exception

loadJob

public Job loadJob(java.io.File file)
            throws java.lang.Exception

Throws:

java.lang.Exception

saveJob

public void saveJob(Job job,
                    java.io.File file)
             throws java.lang.Exception

Throws:

java.lang.Exception

getImgurClientId

public java.lang.String getImgurClientId()

saveBoard

public void saveBoard(Board board)
               throws java.lang.Exception

Throws:

java.lang.Exception

createSerializer

public static Serializer createSerializer()

createId

public static java.lang.String createId(java.lang.String prefix)