Modifier and Type	Class and Description
private static class	MathInputToImageServlet.ImageSavingCallback Does the job of the saving the (first) image rendered to the given output file, recording any `Throwable` for later retrieval.

Modifier and Type	Field and Description
private static final Logger	logger
private static final long	serialVersionUID Hides uk.ac.ed.ph.snuggletex.webapp.BaseServlet.serialVersionUID.

Access	Constructor and Description
public	MathInputToImageServlet()

Modifier and Type	Method and Description
protected void	doGet(HttpServletRequest request, HttpServletResponse response) Overrides javax.servlet.http.HttpServlet.doGet. Called by the server (via the `service` method) to allow a servlet to handle a GET request.
private void	doRequest(HttpServletRequest request, HttpServletResponse response)

logger	back to summary
private static final Logger logger

serialVersionUID	back to summary
private static final long serialVersionUID Hides uk.ac.ed.ph.snuggletex.webapp.BaseServlet.serialVersionUID.

MathInputToImageServlet	back to summary
public MathInputToImageServlet()

Method Detail

doGet back to summary

doGet	back to summary
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException Overrides javax.servlet.http.HttpServlet.doGet. Doc from javax.servlet.http.HttpServlet.doGet. Called by the server (via the `service` method) to allow a servlet to handle a GET request. Overriding this method to support a GET request also automatically supports an HTTP HEAD request. A HEAD request is a GET request that returns no body in the response, only the request header fields. When overriding this method, read the request data, write the response headers, get the response's writer or output stream object, and finally, write the response data. It's best to include content type and encoding. When using a `PrintWriter` object to return the response, set the content type before accessing the `PrintWriter` object. The servlet container must write the headers before committing the response, because in HTTP the headers must be sent before the response body. Where possible, set the Content-Length header (with the `javax.servlet.ServletResponse#setContentLength` method), to allow the servlet container to use a persistent connection to return its response to the client, improving performance. The content length is automatically set if the entire response fits inside the response buffer. When using HTTP 1.1 chunked encoding (which means that the response has a Transfer-Encoding header), do not set the Content-Length header. The GET method should be safe, that is, without any side effects for which users are held responsible. For example, most form queries have no side effects. If a client request is intended to change stored data, the request should use some other HTTP method. The GET method should also be idempotent, meaning that it can be safely repeated. Sometimes making a method safe also makes it idempotent. For example, repeating queries is both safe and idempotent, but buying a product online or modifying data is neither safe nor idempotent. If the request is incorrectly formatted, `doGet` returns an HTTP "Bad Request" message. Annotations @Override Exceptions IOException: if an input or output error is detected when the servlet handles the GET request

protected void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException

Overrides javax.servlet.http.HttpServlet.doGet.

Doc from javax.servlet.http.HttpServlet.doGet.

Called by the server (via the service method) to allow a servlet to handle a GET request.

Overriding this method to support a GET request also automatically supports an HTTP HEAD request. A HEAD request is a GET request that returns no body in the response, only the request header fields.

When overriding this method, read the request data, write the response headers, get the response's writer or output stream object, and finally, write the response data. It's best to include content type and encoding. When using a PrintWriter object to return the response, set the content type before accessing the PrintWriter object.

The servlet container must write the headers before committing the response, because in HTTP the headers must be sent before the response body.

Where possible, set the Content-Length header (with the javax.servlet.ServletResponse#setContentLength method), to allow the servlet container to use a persistent connection to return its response to the client, improving performance. The content length is automatically set if the entire response fits inside the response buffer.

When using HTTP 1.1 chunked encoding (which means that the response has a Transfer-Encoding header), do not set the Content-Length header.

The GET method should be safe, that is, without any side effects for which users are held responsible. For example, most form queries have no side effects. If a client request is intended to change stored data, the request should use some other HTTP method.

The GET method should also be idempotent, meaning that it can be safely repeated. Sometimes making a method safe also makes it idempotent. For example, repeating queries is both safe and idempotent, but buying a product online or modifying data is neither safe nor idempotent.

If the request is incorrectly formatted, doGet returns an HTTP "Bad Request" message.

Annotations

@Override

Exceptions

IOException:: if an input or output error is detected when the servlet handles the GET request

doRequest	back to summary
private void doRequest(HttpServletRequest request, HttpServletResponse response) throws IOException

uk.ac.ed.ph.snuggletex.webapp back to summary

private Class MathInputToImageServlet.ImageSavingCallback

Class Inheritance

extends SimpleMathMLImageSavingCallback

java.lang.Object
uk.ac.ed.ph.snuggletex.jeuclid.SimpleMathMLImageSavingCallback
uk.ac.ed.ph.snuggletex.webapp.MathInputToImageServlet.ImageSavingCallback

Does the job of the saving the (first) image rendered to the given output file, recording any Throwable for later retrieval.

Field Summary

Modifier and Type	Field and Description
private Throwable	failure
private final File	outputFile

Inherited from uk.ac.ed.ph.snuggletex.jeuclid.SimpleMathMLImageSavingCallback:: DEFAULT_ANTI_ALIASING DEFAULT_CONTENT_TYPE DEFAULT_FONT_SIZE

Constructor Summary

Access	Constructor and Description
public	ImageSavingCallback(final File outputFile)

Method Summary

Modifier and Type	Method and Description
public Throwable	getFailure()
public File	getImageOutputFile(int mathmlCounter) Implements abstract uk.ac.ed.ph.snuggletex.jeuclid.SimpleMathMLImageSavingCallback.getImageOutputFile. Implements uk.ac.ed.ph.snuggletex.jeuclid.MathMLImageSavingCallback.getImageOutputFile. Implement if you want the resulting image to be written to a `File` of your choice.
public OutputStream	getImageOutputStream(int mathmlCounter) Implements abstract uk.ac.ed.ph.snuggletex.jeuclid.SimpleMathMLImageSavingCallback.getImageOutputStream. Implements uk.ac.ed.ph.snuggletex.jeuclid.MathMLImageSavingCallback.getImageOutputStream. Implement this if you want the resulting image to be written to an `OutputStream` of your choice.
public String	getImageURL(int mathmlCounter) Implements abstract uk.ac.ed.ph.snuggletex.jeuclid.SimpleMathMLImageSavingCallback.getImageURL. Implements uk.ac.ed.ph.snuggletex.jeuclid.MathMLImageSavingCallback.getImageURL. Implement to return the URL String that will be put into the `img` `src` attribute to refer to the image.
public void	imageSavingFailed(Object imageOutputObject, int mathmlCounter, String contentType, Throwable exception) Implements uk.ac.ed.ph.snuggletex.jeuclid.MathMLImageSavingCallback.imageSavingFailed. Called back if MathML image could not be saved for some reason.

Inherited from uk.ac.ed.ph.snuggletex.jeuclid.SimpleMathMLImageSavingCallback:: getFontSize getImageContentType getImageContentType getLayoutContext imageSavingSucceeded isAntiAliasing setAntiAliasing setFontSize setImageContentType

Field Detail

failure	back to summary
private Throwable failure

outputFile	back to summary
private final File outputFile

Constructor Detail

ImageSavingCallback	back to summary
public ImageSavingCallback(final File outputFile)

Method Detail

getFailure	back to summary
public Throwable getFailure()

getImageOutputFile back to summary

getImageOutputFile	back to summary
public File getImageOutputFile(int mathmlCounter) Implements abstract uk.ac.ed.ph.snuggletex.jeuclid.SimpleMathMLImageSavingCallback.getImageOutputFile. Implements uk.ac.ed.ph.snuggletex.jeuclid.MathMLImageSavingCallback.getImageOutputFile. Doc from uk.ac.ed.ph.snuggletex.jeuclid.MathMLImageSavingCallback.getImageOutputFile. Implement if you want the resulting image to be written to a `File` of your choice. Return null if you want the image to be written to the result of `getImageOutputStream(int)` instead. Annotations @Override

public File getImageOutputFile(int mathmlCounter)

Implements abstract uk.ac.ed.ph.snuggletex.jeuclid.SimpleMathMLImageSavingCallback.getImageOutputFile.

Implements uk.ac.ed.ph.snuggletex.jeuclid.MathMLImageSavingCallback.getImageOutputFile.

Doc from uk.ac.ed.ph.snuggletex.jeuclid.MathMLImageSavingCallback.getImageOutputFile.

Implement if you want the resulting image to be written to a File of your choice. Return null if you want the image to be written to the result of getImageOutputStream(int) instead.

Annotations

@Override

getImageOutputStream back to summary

getImageOutputStream	back to summary
public OutputStream getImageOutputStream(int mathmlCounter) Implements abstract uk.ac.ed.ph.snuggletex.jeuclid.SimpleMathMLImageSavingCallback.getImageOutputStream. Implements uk.ac.ed.ph.snuggletex.jeuclid.MathMLImageSavingCallback.getImageOutputStream. Doc from uk.ac.ed.ph.snuggletex.jeuclid.MathMLImageSavingCallback.getImageOutputStream. Implement this if you want the resulting image to be written to an `OutputStream` of your choice. The method `getImageOutputFile(int)` is checked first, so must return null in this case. Annotations @Override

public OutputStream getImageOutputStream(int mathmlCounter)

Implements abstract uk.ac.ed.ph.snuggletex.jeuclid.SimpleMathMLImageSavingCallback.getImageOutputStream.

Implements uk.ac.ed.ph.snuggletex.jeuclid.MathMLImageSavingCallback.getImageOutputStream.

Doc from uk.ac.ed.ph.snuggletex.jeuclid.MathMLImageSavingCallback.getImageOutputStream.

Implement this if you want the resulting image to be written to an OutputStream of your choice. The method getImageOutputFile(int) is checked first, so must return null in this case.

Annotations

@Override

getImageURL back to summary

getImageURL	back to summary
public String getImageURL(int mathmlCounter) Implements abstract uk.ac.ed.ph.snuggletex.jeuclid.SimpleMathMLImageSavingCallback.getImageURL. Implements uk.ac.ed.ph.snuggletex.jeuclid.MathMLImageSavingCallback.getImageURL. Doc from uk.ac.ed.ph.snuggletex.jeuclid.MathMLImageSavingCallback.getImageURL. Implement to return the URL String that will be put into the `img` `src` attribute to refer to the image. Annotations @Override

public String getImageURL(int mathmlCounter)

Implements abstract uk.ac.ed.ph.snuggletex.jeuclid.SimpleMathMLImageSavingCallback.getImageURL.

Implements uk.ac.ed.ph.snuggletex.jeuclid.MathMLImageSavingCallback.getImageURL.

Doc from uk.ac.ed.ph.snuggletex.jeuclid.MathMLImageSavingCallback.getImageURL.

Implement to return the URL String that will be put into the img src attribute to refer to the image.

Annotations

@Override

imageSavingFailed	back to summary
public void imageSavingFailed(Object imageOutputObject, int mathmlCounter, String contentType, Throwable exception) Implements uk.ac.ed.ph.snuggletex.jeuclid.MathMLImageSavingCallback.imageSavingFailed. Doc from uk.ac.ed.ph.snuggletex.jeuclid.MathMLImageSavingCallback.imageSavingFailed. Called back if MathML image could not be saved for some reason.

imageSavingFailed

back to summary

public void imageSavingFailed(Object imageOutputObject, int mathmlCounter, String contentType, Throwable exception)

Implements uk.ac.ed.ph.snuggletex.jeuclid.MathMLImageSavingCallback.imageSavingFailed.

Doc from uk.ac.ed.ph.snuggletex.jeuclid.MathMLImageSavingCallback.imageSavingFailed.

Called back if MathML image could not be saved for some reason.

public final Class MathInputToImageServlet

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class MathInputToImageServlet.ImageSavingCallback

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail