Class SnapshotMessage
java.lang.Object
zleurtor.scanmanager.model.messages.AbstractMessage
zleurtor.scanmanager.model.messages.SnapshotMessage
- All Implemented Interfaces:
Serializable
The message sent by the server to ask the slaves to take a snapshot.
- Author:
- Zleurtor
- See Also:
-
Field Summary
Fields inherited from class zleurtor.scanmanager.model.messages.AbstractMessage
DISCOVER, LOGGER, STOP
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs an empty message.SnapshotMessage
(String theSubFolder, String theThumbnailInformation, boolean thePolychrome) Constructs a "snapshot" message using the specified subfolder and options. -
Method Summary
Modifier and TypeMethodDescriptionprotected final AbstractMessage
Set this message values to the ones in the given XML description.final String
Returns the subfolder in which the snapshot files shall be stored.final String
Returns the information (width, height and quality) about the thumbnail to produce.boolean
Returns whether or not the snapshot shall be polychromatic.protected final String
toXml()
Transform this message to an XML description.Methods inherited from class zleurtor.scanmanager.model.messages.AbstractMessage
serialize, unserialize
-
Constructor Details
-
SnapshotMessage
public SnapshotMessage()Constructs an empty message. -
SnapshotMessage
Constructs a "snapshot" message using the specified subfolder and options.- Parameters:
theSubFolder
- The subfolder in which the snapshot files shall be stored.theThumbnailInformation
- The information (width, height and quality) about the thumbnail to produce.thePolychrome
- Whether or not the snapshot shall be polychromatic.
-
-
Method Details
-
getSubFolder
Returns the subfolder in which the snapshot files shall be stored.- Returns:
- The subfolder in which the snapshot files shall be stored.
-
getThumbnailInformation
Returns the information (width, height and quality) about the thumbnail to produce.- Returns:
- The information (width, height and quality) about the thumbnail to produce.
-
isPolychrome
public boolean isPolychrome()Returns whether or not the snapshot shall be polychromatic.- Returns:
- Whether or not the snapshot shall be polychromatic.
-
toXml
protected final String toXml() throws ParserConfigurationException, TransformerFactoryConfigurationError, TransformerException, IOExceptionDescription copied from class:AbstractMessage
Transform this message to an XML description.- Specified by:
toXml
in classAbstractMessage
- Returns:
- An XML describing this message.
- Throws:
ParserConfigurationException
- If a DocumentBuildercannot be created which satisfies the configuration requested.TransformerFactoryConfigurationError
- Thrown in case of service configuration error or ifthe implementation is not available or cannot be instantiated.TransformerException
- When it is not possible to create a Transformer instance or if an unrecoverable error occurs during the course of the transformation.IOException
- If an I/O error occurs.
-
fromXml
protected final AbstractMessage fromXml(String xml) throws SAXException, IOException, ParserConfigurationException, XPathExpressionException Description copied from class:AbstractMessage
Set this message values to the ones in the given XML description.- Specified by:
fromXml
in classAbstractMessage
- Parameters:
xml
- The XML containing the values to set in this message.- Returns:
- This message.
- Throws:
SAXException
- If any parse errors occur.IOException
- If any IO errors occur.ParserConfigurationException
- If a DocumentBuildercannot be created which satisfies the configuration requested.XPathExpressionException
- If an XPath expression cannot be evaluated.
-