Index (gytheio-transform-commons 0.3 API)

A C D E F G H I K L M O P R S T V

A

AbstractContentTransformerWorker - Class in org.gytheio.content.transform: Abstract transform node worker which uses a content reference handler to convert the content reference into a usable File object for the actual implementation.
AbstractContentTransformerWorker() - Constructor for class org.gytheio.content.transform.AbstractContentTransformerWorker
AbstractFileContentTransformerWorker - Class in org.gytheio.content.transform: Extension of AbstractContentTransformerWorker for dealing with file content references
AbstractFileContentTransformerWorker() - Constructor for class org.gytheio.content.transform.AbstractFileContentTransformerWorker
AbstractFileContentTransformerWorker.FileContentReferencePair - Class in org.gytheio.content.transform: Wrapper for a content reference and a File, useful for passing around an already instantiated File object with a related content reference.
AbstractFileContentTransformerWorker.FileContentReferencePair(File, ContentReference) - Constructor for class org.gytheio.content.transform.AbstractFileContentTransformerWorker.FileContentReferencePair
AbstractRuntimeExecContentTransformerWorker - Class in org.gytheio.content.transform: Base class that uses a command line RuntimeExec to perform the transform
AbstractRuntimeExecContentTransformerWorker() - Constructor for class org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker: Default constructor
AbstractTransformationSourceOptions - Class in org.gytheio.content.transform.options: Base implementation of TransformationSourceOptions which holds applicable mimetypes and handles merge of options.
AbstractTransformationSourceOptions() - Constructor for class org.gytheio.content.transform.options.AbstractTransformationSourceOptions
AbstractTransformationSourceOptions(AbstractTransformationSourceOptions) - Constructor for class org.gytheio.content.transform.options.AbstractTransformationSourceOptions: Constructs a field copy object from the given
addSourceOptions(TransformationSourceOptions) - Method in interface org.gytheio.content.transform.options.TransformationOptions: Adds the given sourceOptions to the sourceOptionsMap.
addSourceOptions(TransformationSourceOptions) - Method in class org.gytheio.content.transform.options.TransformationOptionsImpl
append(StringBuilder, String, String) - Method in class org.gytheio.content.transform.options.TransformationOptionPair
AUDIO_CODEC_AAC - Static variable in class org.gytheio.content.transform.options.AudioTransformationOptions
AUDIO_CODEC_MP3 - Static variable in class org.gytheio.content.transform.options.AudioTransformationOptions
AUDIO_CODEC_PASSTHROUGH - Static variable in class org.gytheio.content.transform.options.AudioTransformationOptions
AUDIO_CODEC_VORBIS - Static variable in class org.gytheio.content.transform.options.AudioTransformationOptions
AUDIO_CODEC_WMA - Static variable in class org.gytheio.content.transform.options.AudioTransformationOptions
AudioTransformationOptions - Class in org.gytheio.content.transform.options: Options relating to audio transformations
AudioTransformationOptions() - Constructor for class org.gytheio.content.transform.options.AudioTransformationOptions
AudioTransformationOptions(AudioTransformationOptions) - Constructor for class org.gytheio.content.transform.options.AudioTransformationOptions

C

combine(TransformationOptionLimits) - Method in class org.gytheio.content.transform.options.TransformationOptionLimits: Returns a TransformationOptionLimits that has getter methods that combine the the values from the getter methods of this and the supplied TransformationOptionLimits.
combine(TransformationOptionPair) - Method in class org.gytheio.content.transform.options.TransformationOptionPair: Returns a TransformationOptionPair that has getter methods that combine the the values from the getter methods of this and the supplied TransformationOptionPair.
combineUpper(TransformationOptionLimits) - Method in class org.gytheio.content.transform.options.TransformationOptionLimits: Returns a TransformationOptionLimits that has getter methods that combine the the values from the getter methods of this and the supplied TransformationOptionLimits so that they return the lowest common denominator of the limits .
combineUpper(TransformationOptionPair) - Method in class org.gytheio.content.transform.options.TransformationOptionPair: Returns a TransformationOptionPair that has getter methods that combine the the values from the getter methods of this and the supplied TransformationOptionPair so that they return the lowest common denominator of the two limits .
ContentTransformerWorker - Interface in org.gytheio.content.transform: Defines the methods responsible for doing the work of transformation of a content reference
ContentTransformerWorkerProgressReporter - Interface in org.gytheio.content.transform: Defines methods for reporting progress on a content transformation.
convertSecondsToTimecode(float) - Static method in class org.gytheio.content.transform.util.TimecodeUtils: Convert the given number of seconds into a timecode string of the form "HH:mm:ss.SSS"
convertSecondsToTimecode(float, int) - Static method in class org.gytheio.content.transform.util.TimecodeUtils: Convert the given number of seconds into a timecode string of the form "HH:mm:ss.SSS" where the given decimalScale indicates the number of digits to retain after the decimal point
convertTimecodeToSeconds(String) - Static method in class org.gytheio.content.transform.util.TimecodeUtils: Converts the given timecode string of the form "HH:mm:ss[.SSS]" to the total number of seconds it represents
createSerializerInstance() - Static method in class org.gytheio.content.transform.options.CropSourceOptions: Creates an instance of the options serializer
createSerializerInstance() - Static method in class org.gytheio.content.transform.options.PagedSourceOptions: Creates an instance of the options serializer
createSerializerInstance() - Static method in class org.gytheio.content.transform.options.TemporalSourceOptions: Creates an instance of the options serializer
createTargetContentReference(String) - Method in class org.gytheio.content.transform.AbstractFileContentTransformerWorker: Creates a target content references using the targetContentReferenceHandler
createTempFile(ContentReference) - Method in class org.gytheio.content.transform.AbstractFileContentTransformerWorker: Creates a temp file from the given content reference
CropSourceOptions - Class in org.gytheio.content.transform.options: DTO used to store options for ImageMagick cropping.
CropSourceOptions() - Constructor for class org.gytheio.content.transform.options.CropSourceOptions
CropSourceOptions(CropSourceOptions) - Constructor for class org.gytheio.content.transform.options.CropSourceOptions
CropSourceOptions.CropSourceOptionsSerializer - Class in org.gytheio.content.transform.options: Serializer for crop source options
CropSourceOptions.CropSourceOptionsSerializer() - Constructor for class org.gytheio.content.transform.options.CropSourceOptions.CropSourceOptionsSerializer

D

debug(String) - Method in interface org.gytheio.content.transform.TransformerDebug
debug(String, Throwable) - Method in interface org.gytheio.content.transform.TransformerDebug
deepCopySourceOptionsMap(Map<Class<? extends TransformationSourceOptions>, TransformationSourceOptions>) - Method in class org.gytheio.content.transform.options.TransformationOptionsImpl
defaultTo(TransformationOptionLimits) - Method in class org.gytheio.content.transform.options.TransformationOptionLimits: Defaults values that are set in this object into the supplied limits.
defaultTo(TransformationOptionPair) - Method in class org.gytheio.content.transform.options.TransformationOptionPair: Defaults values that are set in this pair into the supplied pair.
deserialize(SerializedTransformationOptionsAccessor) - Method in class org.gytheio.content.transform.options.CropSourceOptions.CropSourceOptionsSerializer
deserialize(SerializedTransformationOptionsAccessor) - Method in class org.gytheio.content.transform.options.PagedSourceOptions.PagedSourceOptionsSerializer
deserialize(SerializedTransformationOptionsAccessor) - Method in class org.gytheio.content.transform.options.TemporalSourceOptions.TemporalSourceOptionsSerializer
deserialize(SerializedTransformationOptionsAccessor) - Method in interface org.gytheio.content.transform.options.TransformationSourceOptions.TransformationSourceOptionsSerializer: Gets the parameters from the serialized options accessor and builds a source options object.

E

equals(Object) - Method in class org.gytheio.content.transform.options.TransformationOptionLimits
equals(Object) - Method in class org.gytheio.content.transform.options.TransformationOptionPair
executer - Variable in class org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker: the system command executer

F

fileDetailsExecuter - Variable in class org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker: optional file details executer

G

getAction() - Method in class org.gytheio.content.transform.options.TransformationOptionPair
getAdditionalOptions() - Method in interface org.gytheio.content.transform.options.TransformationOptions: Gets the additional transformation options not explicitly modeled in an implementation.
getAdditionalOptions() - Method in class org.gytheio.content.transform.options.TransformationOptionsImpl
getAllowEnlargement() - Method in class org.gytheio.content.transform.options.ImageResizeOptions
getApplicableMediaTypes() - Method in class org.gytheio.content.transform.options.AbstractTransformationSourceOptions: Gets the list of applicable media types
getApplicableMediaTypes() - Method in interface org.gytheio.content.transform.options.TransformationSourceOptions: Gets the list of applicable media types (mimetypes)
getCheckedParam(String, Class<T>) - Method in interface org.gytheio.content.transform.options.SerializedTransformationOptionsAccessor: Gets the value for the named parameter.
getCommandOptions() - Method in class org.gytheio.content.transform.options.ImageTransformationOptions: Get the command string options
getContentReference() - Method in class org.gytheio.content.transform.AbstractFileContentTransformerWorker.FileContentReferencePair
getDefaultApplicableMimetypes() - Static method in class org.gytheio.content.transform.options.PagedSourceOptions
getDetails(File) - Method in class org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker: Optional method for implementations able to return details of a file which will vary greatly depending on the file type and implementation.
getDuration() - Method in class org.gytheio.content.transform.options.TemporalSourceOptions: Gets the duration of the source to read with a format of hh:mm:ss[.xxx]
getElementIntervalSeconds() - Method in class org.gytheio.content.transform.options.TemporalSourceOptions: Gets the interval in seconds to pull elements from the source, i.e.
getEndPageNumber() - Method in class org.gytheio.content.transform.options.PagedSourceOptions: Gets the page number to end at in the source document
getExtension(ContentReference) - Method in class org.gytheio.content.transform.AbstractContentTransformerWorker
getFile() - Method in class org.gytheio.content.transform.AbstractFileContentTransformerWorker.FileContentReferencePair
getGravity() - Method in class org.gytheio.content.transform.options.CropSourceOptions: Gets the 'gravity' which determines how the offset is applied.
getHeight() - Method in class org.gytheio.content.transform.options.CropSourceOptions: Gets the height of the cropped image.
getHeight() - Method in class org.gytheio.content.transform.options.ImageResizeOptions
getIncludeEmbedded() - Method in interface org.gytheio.content.transform.options.TransformationOptions: If the source content includes embedded resources, should the transformer attempt to transform these as well? Not many transformers do support embedded resources, so this option will only affect those that can.
getIncludeEmbedded() - Method in class org.gytheio.content.transform.options.TransformationOptionsImpl
getIntegerParam(String, int) - Method in interface org.gytheio.content.transform.options.SerializedTransformationOptionsAccessor: Gets the int value for the named parameter.
getKBytesPair() - Method in class org.gytheio.content.transform.options.TransformationOptionLimits
getLimit() - Method in class org.gytheio.content.transform.options.TransformationOptionPair
getMax() - Method in class org.gytheio.content.transform.options.TransformationOptionPair
getMaxElements() - Method in class org.gytheio.content.transform.options.TemporalSourceOptions: Gets the maximum number of elements that should be returned from the transformation.
getMaxPages() - Method in class org.gytheio.content.transform.options.TransformationOptionLimits
getMaxSourceSizeKBytes() - Method in class org.gytheio.content.transform.options.TransformationOptionLimits
getOffset() - Method in class org.gytheio.content.transform.options.TemporalSourceOptions: Gets the offset time code from which to start the transformation with a format of hh:mm:ss[.xxx]
getPage1Instance() - Static method in class org.gytheio.content.transform.options.PagedSourceOptions: Gets paged source options which specify just the first page.
getPageLimit() - Method in class org.gytheio.content.transform.options.TransformationOptionLimits
getPageLimit() - Method in interface org.gytheio.content.transform.options.TransformationOptions: Get the page limit before returning EOF.
getPageLimit() - Method in class org.gytheio.content.transform.options.TransformationOptionsImpl
getPagesPair() - Method in class org.gytheio.content.transform.options.TransformationOptionLimits
getParamWithDefault(String, T) - Method in interface org.gytheio.content.transform.options.SerializedTransformationOptionsAccessor: Gets the value for the named parameter.
getReadLimitKBytes() - Method in class org.gytheio.content.transform.options.TransformationOptionLimits
getReadLimitTimeMs() - Method in class org.gytheio.content.transform.options.TransformationOptionLimits
getResizeOptions() - Method in class org.gytheio.content.transform.options.ImageTransformationOptions: Get the image resize options
getResizeOptions() - Method in class org.gytheio.content.transform.options.VideoTransformationOptions: Get the image resize options
getRotationDegrees() - Method in class org.gytheio.content.transform.options.ImageTransformationOptions: Gets the rotation in degrees to rotate the image about its center
getSerializer() - Method in class org.gytheio.content.transform.options.CropSourceOptions
getSerializer() - Method in class org.gytheio.content.transform.options.PagedSourceOptions
getSerializer() - Method in class org.gytheio.content.transform.options.TemporalSourceOptions
getSerializer() - Method in interface org.gytheio.content.transform.options.TransformationSourceOptions: Gets the serializer for the source options.
getSourceOptions(Class<T>) - Method in interface org.gytheio.content.transform.options.TransformationOptions: Gets the appropriate source options for the given mimetype if available.
getSourceOptions(Class<T>) - Method in class org.gytheio.content.transform.options.TransformationOptionsImpl
getSourceOptionsMap() - Method in interface org.gytheio.content.transform.options.TransformationOptions: Gets the map of TransformationSourceOptions class to an object of that class holding the source options values.
getSourceOptionsMap() - Method in class org.gytheio.content.transform.options.TransformationOptionsImpl
getSourcePairs(List<ContentReference>) - Method in class org.gytheio.content.transform.AbstractFileContentTransformerWorker: Creates source pairs from the given source content references
getStartPageNumber() - Method in class org.gytheio.content.transform.options.PagedSourceOptions: Gets the page number to start from in the source document
getTargetAudioBitrate() - Method in class org.gytheio.content.transform.options.AudioTransformationOptions: Gets the audio bitrate to use for the target of the transformation
getTargetAudioChannels() - Method in class org.gytheio.content.transform.options.AudioTransformationOptions: Gets the number of audio channels to use for the target of the transformation
getTargetAudioCodec() - Method in class org.gytheio.content.transform.options.AudioTransformationOptions: Gets the audio codec to use for the target of the transformation
getTargetAudioSamplingRate() - Method in class org.gytheio.content.transform.options.AudioTransformationOptions: Gets the audio sampling rate to use for the target of the transformation
getTargetFastStartEnabled() - Method in class org.gytheio.content.transform.options.AudioTransformationOptions: Gets whether or not the moov atom should be moved to the start of the file if supported.
getTargetPairs(List<ContentReference>) - Method in class org.gytheio.content.transform.AbstractFileContentTransformerWorker: Creates target pairs from the given target content references
getTargetVideoBitrate() - Method in class org.gytheio.content.transform.options.VideoTransformationOptions: Gets the video bitrate to use for the target of the transformation
getTargetVideoCodec() - Method in class org.gytheio.content.transform.options.VideoTransformationOptions: Gets the video codec to use for the target of the transformation
getTargetVideoCodecProfile() - Method in class org.gytheio.content.transform.options.VideoTransformationOptions: Gets the video codec profile to use for the target of the transformation
getTargetVideoFrameRate() - Method in class org.gytheio.content.transform.options.VideoTransformationOptions: Gets the video frame rate to use for the target of the transformation
getTimeoutMs() - Method in class org.gytheio.content.transform.options.TransformationOptionLimits
getTimeoutMs() - Method in interface org.gytheio.content.transform.options.TransformationOptions: Gets the timeout (ms) on the InputStream after which an IOExecption is thrown to terminate very slow transformations or a subprocess is terminated (killed).
getTimeoutMs() - Method in class org.gytheio.content.transform.options.TransformationOptionsImpl
getTimePair() - Method in class org.gytheio.content.transform.options.TransformationOptionLimits
getValue() - Method in class org.gytheio.content.transform.options.TransformationOptionPair
getWidth() - Method in class org.gytheio.content.transform.options.CropSourceOptions: Sets the width of the cropped image.
getWidth() - Method in class org.gytheio.content.transform.options.ImageResizeOptions
getXOffset() - Method in class org.gytheio.content.transform.options.CropSourceOptions: Gets the horizontal offset.
getYOffset() - Method in class org.gytheio.content.transform.options.CropSourceOptions: Gets the vertical offset.

H

hashCode() - Method in class org.gytheio.content.transform.options.TransformationOptionLimits
hashCode() - Method in class org.gytheio.content.transform.options.TransformationOptionPair

I

ImageResizeOptions - Class in org.gytheio.content.transform.options: Image resize options
ImageResizeOptions() - Constructor for class org.gytheio.content.transform.options.ImageResizeOptions: Default constructor
ImageTransformationOptions - Class in org.gytheio.content.transform.options: Image transformation options
ImageTransformationOptions() - Constructor for class org.gytheio.content.transform.options.ImageTransformationOptions
ImageTransformationOptions(ImageTransformationOptions) - Constructor for class org.gytheio.content.transform.options.ImageTransformationOptions
initDefaults() - Method in class org.gytheio.content.transform.options.CropSourceOptions
initializationTest(String, String, TransformationOptions) - Method in class org.gytheio.content.transform.AbstractFileContentTransformerWorker: Tests that the worker is configured and working as expected.
initializationTest() - Method in class org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker: Perform a transformation that verifies the executer is installed and configured correctly
initialize() - Method in class org.gytheio.content.transform.AbstractContentTransformerWorker
initialize() - Method in class org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker: Checks for the JMagick and ImageMagick dependencies, using the common transformation method to check that the sample image can be converted.
initializeExecuter() - Method in class org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker: Perform any initialization needed for the primary executer including creating if null
initializeFileDetailsExecuter() - Method in class org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker: Perform any initialization needed for the file details executer including creating if null
initializeVersionDetailsExecuter() - Method in class org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker: Perform any initialization needed for the version details executer including creating if null
initializeVersionDetailsString() - Method in class org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker
isApplicableForMediaType(String) - Method in class org.gytheio.content.transform.options.AbstractTransformationSourceOptions: Gets whether or not these transformation source options apply for the given media type
isApplicableForMediaType(String) - Method in class org.gytheio.content.transform.options.CropSourceOptions
isApplicableForMediaType(String) - Method in class org.gytheio.content.transform.options.TemporalSourceOptions
isApplicableForMediaType(String) - Method in interface org.gytheio.content.transform.options.TransformationSourceOptions: Gets whether or not these transformation source options apply for the given media type (mimetype)
isAutoOrient() - Method in class org.gytheio.content.transform.options.ImageTransformationOptions
isEnabled() - Method in interface org.gytheio.content.transform.TransformerDebug
isMaintainAspectRatio() - Method in class org.gytheio.content.transform.options.ImageResizeOptions
isPercentageCrop() - Method in class org.gytheio.content.transform.options.CropSourceOptions
isPercentResize() - Method in class org.gytheio.content.transform.options.ImageResizeOptions
isResizeToThumbnail() - Method in class org.gytheio.content.transform.options.ImageResizeOptions
isTempTargetUsed() - Method in class org.gytheio.content.transform.AbstractFileContentTransformerWorker: Determines if the target content references must be managed via local temp file copies or can be managed directly.
isTransformable(List<String>, String, TransformationOptions) - Method in interface org.gytheio.content.transform.ContentTransformerWorker: Determines whether or not the worker can handle the transformation from the given source media types to the given target media type with the given options.

K

KBYTES_MESSAGE - Static variable in class org.gytheio.content.transform.options.TransformationOptionLimits

L

LoggingProgressReporterImpl - Class in org.gytheio.content.transform: Progress reporter which logs via a given logger.
LoggingProgressReporterImpl(Log) - Constructor for class org.gytheio.content.transform.LoggingProgressReporterImpl

M

merge(TransformationSourceOptions) - Method in class org.gytheio.content.transform.options.AbstractTransformationSourceOptions
merge(TransformationOptions) - Method in class org.gytheio.content.transform.options.AudioTransformationOptions
merge(TransformationOptions) - Method in class org.gytheio.content.transform.options.ImageTransformationOptions
merge(TransformationOptions) - Method in class org.gytheio.content.transform.options.TransformationOptionsImpl

O

onTransformationComplete(List<ContentWorkResult>) - Method in interface org.gytheio.content.transform.ContentTransformerWorkerProgressReporter: Called when the transformation has completed
onTransformationComplete(List<ContentWorkResult>) - Method in class org.gytheio.content.transform.LoggingProgressReporterImpl
onTransformationError(String) - Method in interface org.gytheio.content.transform.ContentTransformerWorkerProgressReporter: Called when there was an error performing the transformation
onTransformationError(String) - Method in class org.gytheio.content.transform.LoggingProgressReporterImpl
onTransformationProgress(float) - Method in interface org.gytheio.content.transform.ContentTransformerWorkerProgressReporter: Optionally called when some amount of progress has been made on the transformation
onTransformationProgress(float) - Method in class org.gytheio.content.transform.LoggingProgressReporterImpl
onTransformationStarted() - Method in interface org.gytheio.content.transform.ContentTransformerWorkerProgressReporter: Called when the transformation has been started
onTransformationStarted() - Method in class org.gytheio.content.transform.LoggingProgressReporterImpl
OPT_COMMAND_OPTIONS - Static variable in class org.gytheio.content.transform.options.ImageTransformationOptions
OPT_IMAGE_AUTO_ORIENTATION - Static variable in class org.gytheio.content.transform.options.ImageTransformationOptions
OPT_IMAGE_RESIZE_OPTIONS - Static variable in class org.gytheio.content.transform.options.ImageTransformationOptions
OPT_MAX_PAGES - Static variable in class org.gytheio.content.transform.options.TransformationOptionLimits
OPT_MAX_SOURCE_SIZE_K_BYTES - Static variable in class org.gytheio.content.transform.options.TransformationOptionLimits
OPT_PAGE_LIMIT - Static variable in class org.gytheio.content.transform.options.TransformationOptionLimits
OPT_READ_LIMIT_K_BYTES - Static variable in class org.gytheio.content.transform.options.TransformationOptionLimits
OPT_READ_LIMIT_TIME_MS - Static variable in class org.gytheio.content.transform.options.TransformationOptionLimits
OPT_TIMEOUT_MS - Static variable in class org.gytheio.content.transform.options.TransformationOptionLimits
org.gytheio.content.transform - package org.gytheio.content.transform
org.gytheio.content.transform.options - package org.gytheio.content.transform.options
org.gytheio.content.transform.util - package org.gytheio.content.transform.util

P

PAGE_1 - Static variable in class org.gytheio.content.transform.options.PagedSourceOptions
PagedSourceOptions - Class in org.gytheio.content.transform.options: Paged content conversion options to specify a page number range.
PagedSourceOptions() - Constructor for class org.gytheio.content.transform.options.PagedSourceOptions
PagedSourceOptions(PagedSourceOptions) - Constructor for class org.gytheio.content.transform.options.PagedSourceOptions
PagedSourceOptions.PagedSourceOptionsSerializer - Class in org.gytheio.content.transform.options: Serializer for paged source options
PagedSourceOptions.PagedSourceOptionsSerializer() - Constructor for class org.gytheio.content.transform.options.PagedSourceOptions.PagedSourceOptionsSerializer
PAGES_MESSAGE - Static variable in class org.gytheio.content.transform.options.TransformationOptionLimits
PARAM_CROP_GRAVITY - Static variable in class org.gytheio.content.transform.options.CropSourceOptions.CropSourceOptionsSerializer: This optional String parameter determines the 'zero' position from which offsets are measured and also determines the direction of offsets.
PARAM_CROP_HEIGHT - Static variable in class org.gytheio.content.transform.options.CropSourceOptions.CropSourceOptionsSerializer: This optional Integer or Float parameter specifies the height of the image after cropping.
PARAM_CROP_WIDTH - Static variable in class org.gytheio.content.transform.options.CropSourceOptions.CropSourceOptionsSerializer: This optional Integer or Float parameter specifies the width of the image after cropping.
PARAM_CROP_X_OFFSET - Static variable in class org.gytheio.content.transform.options.CropSourceOptions.CropSourceOptionsSerializer: This optional Integer parameter specifies the horizontal position of the start point of the area to be cropped.
PARAM_CROP_Y_OFFSET - Static variable in class org.gytheio.content.transform.options.CropSourceOptions.CropSourceOptionsSerializer: This optional Integer parameter specifies the vertical position of the start point of the area to be cropped.
PARAM_IS_PERCENT_CROP - Static variable in class org.gytheio.content.transform.options.CropSourceOptions.CropSourceOptionsSerializer: This optional Boolean flag parameter specifies how the PARAM_CROP_HEIGHT and PARAM_CROP_WIDTH parameters are interpreted.
PARAM_SOURCE_END_PAGE - Static variable in class org.gytheio.content.transform.options.PagedSourceOptions.PagedSourceOptionsSerializer
PARAM_SOURCE_START_PAGE - Static variable in class org.gytheio.content.transform.options.PagedSourceOptions.PagedSourceOptionsSerializer
PARAM_SOURCE_TIME_DURATION - Static variable in class org.gytheio.content.transform.options.TemporalSourceOptions.TemporalSourceOptionsSerializer
PARAM_SOURCE_TIME_ELEMENT_INTERVAL - Static variable in class org.gytheio.content.transform.options.TemporalSourceOptions.TemporalSourceOptionsSerializer
PARAM_SOURCE_TIME_MAX_ELEMENTS - Static variable in class org.gytheio.content.transform.options.TemporalSourceOptions.TemporalSourceOptionsSerializer
PARAM_SOURCE_TIME_OFFSET - Static variable in class org.gytheio.content.transform.options.TemporalSourceOptions.TemporalSourceOptionsSerializer
putParameterIfNotNull(String, Serializable, Map<String, Serializable>) - Method in class org.gytheio.content.transform.options.AbstractTransformationSourceOptions: Adds the given paramValue to the given params if it's not null.

R

removeFromMap(Map<String, Object>) - Static method in class org.gytheio.content.transform.options.TransformationOptionLimits

S

serialize(TransformationSourceOptions, Map<String, Serializable>) - Method in class org.gytheio.content.transform.options.CropSourceOptions.CropSourceOptionsSerializer
serialize(TransformationSourceOptions, Map<String, Serializable>) - Method in class org.gytheio.content.transform.options.PagedSourceOptions.PagedSourceOptionsSerializer
serialize(TransformationSourceOptions, Map<String, Serializable>) - Method in class org.gytheio.content.transform.options.TemporalSourceOptions.TemporalSourceOptionsSerializer
serialize(TransformationSourceOptions, Map<String, Serializable>) - Method in interface org.gytheio.content.transform.options.TransformationSourceOptions.TransformationSourceOptionsSerializer: Serializes the given transformation source options into the given parameter map.
SerializedTransformationOptionsAccessor - Interface in org.gytheio.content.transform.options: Defines methods for retrieving parameter values for use in building transformation options.
set(Map<String, Object>) - Method in class org.gytheio.content.transform.options.TransformationOptionLimits
set(Map<String, Object>, String, String, String) - Method in class org.gytheio.content.transform.options.TransformationOptionPair
setAdditionalOptions(Map<String, Serializable>) - Method in interface org.gytheio.content.transform.options.TransformationOptions: Sets the additional transformation options not explicitly modeled in an implementation.
setAdditionalOptions(Map<String, Serializable>) - Method in class org.gytheio.content.transform.options.TransformationOptionsImpl
setAllowEnlargement(boolean) - Method in class org.gytheio.content.transform.options.ImageResizeOptions
setApplicableMediaTypes(List<String>) - Method in class org.gytheio.content.transform.options.AbstractTransformationSourceOptions: Sets the list of applicable media types
setAutoOrient(boolean) - Method in class org.gytheio.content.transform.options.ImageTransformationOptions
setCause(T) - Method in interface org.gytheio.content.transform.TransformerDebug
setCommandOptions(String) - Method in class org.gytheio.content.transform.options.ImageTransformationOptions: Set the command string options
setContentReference(ContentReference) - Method in class org.gytheio.content.transform.AbstractFileContentTransformerWorker.FileContentReferencePair
setDuration(String) - Method in class org.gytheio.content.transform.options.TemporalSourceOptions: Sets the duration of the source to read with a format of hh:mm:ss[.xxx]
setElementIntervalSeconds(Integer) - Method in class org.gytheio.content.transform.options.TemporalSourceOptions: Sets the interval in seconds to pull elements from the source, i.e.
setEndPageNumber(Integer) - Method in class org.gytheio.content.transform.options.PagedSourceOptions: Sets the page number to end at in the source document
setExecuter(RuntimeExec) - Method in class org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker: Set the runtime command executer that must be executed.
setFile(File) - Method in class org.gytheio.content.transform.AbstractFileContentTransformerWorker.FileContentReferencePair
setGravity(String) - Method in class org.gytheio.content.transform.options.CropSourceOptions: Sets the 'gravity' which determines how the offset is applied.
setHeight(int) - Method in class org.gytheio.content.transform.options.CropSourceOptions: Sets the height of the cropped image.
setHeight(int) - Method in class org.gytheio.content.transform.options.ImageResizeOptions
setIncludeEmbedded(Boolean) - Method in interface org.gytheio.content.transform.options.TransformationOptions: If the source content includes embedded resources, should the transformer attempt to transform these as well? Not many transformers do support embedded resources, so this option will only affect those that can.
setIncludeEmbedded(Boolean) - Method in class org.gytheio.content.transform.options.TransformationOptionsImpl
setLimit(long, String) - Method in class org.gytheio.content.transform.options.TransformationOptionPair
setMaintainAspectRatio(boolean) - Method in class org.gytheio.content.transform.options.ImageResizeOptions
setMax(long, String) - Method in class org.gytheio.content.transform.options.TransformationOptionPair
setMaxElements(Integer) - Method in class org.gytheio.content.transform.options.TemporalSourceOptions: Sets the maximum number of elements that should be returned from the transformation.
setMaxPages(int) - Method in class org.gytheio.content.transform.options.TransformationOptionLimits
setMaxSourceSizeKBytes(long) - Method in class org.gytheio.content.transform.options.TransformationOptionLimits
setOffset(String) - Method in class org.gytheio.content.transform.options.TemporalSourceOptions: Sets the offset time code from which to start the transformation with a format of hh:mm:ss[.xxx]
setPageLimit(int) - Method in class org.gytheio.content.transform.options.TransformationOptionLimits
setPageLimit(int) - Method in interface org.gytheio.content.transform.options.TransformationOptions: Set the number of pages read from the source before returning EOF.
setPageLimit(int) - Method in class org.gytheio.content.transform.options.TransformationOptionsImpl
setPercentageCrop(boolean) - Method in class org.gytheio.content.transform.options.CropSourceOptions
setPercentResize(boolean) - Method in class org.gytheio.content.transform.options.ImageResizeOptions
setReadLimitKBytes(long) - Method in class org.gytheio.content.transform.options.TransformationOptionLimits
setReadLimitTimeMs(long) - Method in class org.gytheio.content.transform.options.TransformationOptionLimits
setResizeOptions(ImageResizeOptions) - Method in class org.gytheio.content.transform.options.ImageTransformationOptions: Set the image resize options
setResizeOptions(ImageResizeOptions) - Method in class org.gytheio.content.transform.options.VideoTransformationOptions: Set the image resize options
setResizeToThumbnail(boolean) - Method in class org.gytheio.content.transform.options.ImageResizeOptions
setRotationDegrees(Float) - Method in class org.gytheio.content.transform.options.ImageTransformationOptions: Sets the rotation in degrees to rotate the image about its center
setSourceOptionsList(Collection<TransformationSourceOptions>) - Method in interface org.gytheio.content.transform.options.TransformationOptions: Sets the list of source options further describing how the source should be transformed based on its mimetype.
setSourceOptionsList(Collection<TransformationSourceOptions>) - Method in class org.gytheio.content.transform.options.TransformationOptionsImpl
setSourceOptionsMap(Map<Class<? extends TransformationSourceOptions>, TransformationSourceOptions>) - Method in interface org.gytheio.content.transform.options.TransformationOptions: Sets the map of TransformationSourceOptions class to an object of that class holding the source options values.
setSourceOptionsMap(Map<Class<? extends TransformationSourceOptions>, TransformationSourceOptions>) - Method in class org.gytheio.content.transform.options.TransformationOptionsImpl
setStartPageNumber(Integer) - Method in class org.gytheio.content.transform.options.PagedSourceOptions: Sets the page number to start from in the source document
setTargetAudioBitrate(Long) - Method in class org.gytheio.content.transform.options.AudioTransformationOptions: Sets the audio bitrate to use for the target of the transformation
setTargetAudioChannels(Integer) - Method in class org.gytheio.content.transform.options.AudioTransformationOptions: Sets the number of audio channels to use for the target of the transformation
setTargetAudioCodec(String) - Method in class org.gytheio.content.transform.options.AudioTransformationOptions: Sets the audio codec to use for the target of the transformation
setTargetAudioSamplingRate(Integer) - Method in class org.gytheio.content.transform.options.AudioTransformationOptions: Sets the audio sampling rate to use for the target of the transformation
setTargetContentReferenceHandler(ContentReferenceHandler) - Method in class org.gytheio.content.transform.AbstractContentTransformerWorker
setTargetFastStartEnabled(boolean) - Method in class org.gytheio.content.transform.options.AudioTransformationOptions: Sets whether or not the moov atom should be moved to the start of the file if supported.
setTargetVideoBitrate(Long) - Method in class org.gytheio.content.transform.options.VideoTransformationOptions: Sets the video bitrate to use for the target of the transformation
setTargetVideoCodec(String) - Method in class org.gytheio.content.transform.options.VideoTransformationOptions: Sets the video codec to use for the target of the transformation
setTargetVideoCodecProfile(String) - Method in class org.gytheio.content.transform.options.VideoTransformationOptions: Sets the video codec profile to use for the target of the transformation
setTargetVideoFrameRate(Float) - Method in class org.gytheio.content.transform.options.VideoTransformationOptions: Sets the video frame rate to use for the target of the transformation
setTimeoutMs(long) - Method in class org.gytheio.content.transform.options.TransformationOptionLimits
setTimeoutMs(long) - Method in interface org.gytheio.content.transform.options.TransformationOptions: Sets a timeout (ms) on the InputStream after which an IOExecption is thrown to terminate very slow transformations or to terminate (kill) a subprocess.
setTimeoutMs(long) - Method in class org.gytheio.content.transform.options.TransformationOptionsImpl
setVersionDetailsExecuter(RuntimeExec) - Method in class org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker: Sets the command that must be executed in order to retrieve version information from the converting executable and thus test that the executable itself is present.
setWidth(int) - Method in class org.gytheio.content.transform.options.CropSourceOptions: Sets the width of the cropped image.
setWidth(int) - Method in class org.gytheio.content.transform.options.ImageResizeOptions
setXOffset(int) - Method in class org.gytheio.content.transform.options.CropSourceOptions: Sets the horizontal offset.
setYOffset(int) - Method in class org.gytheio.content.transform.options.CropSourceOptions: Sets the vertical offset.
supported() - Method in class org.gytheio.content.transform.options.TransformationOptionLimits: Indicates if the limits allow a transformation to take place at all.
supported() - Method in class org.gytheio.content.transform.options.TransformationOptionPair: Indicates if the limit allows a transformation to take place at all.

T

targetContentReferenceHandler - Variable in class org.gytheio.content.transform.AbstractContentTransformerWorker
TemporalSourceOptions - Class in org.gytheio.content.transform.options: Time-based content conversion options to specify an offset and duration.
TemporalSourceOptions() - Constructor for class org.gytheio.content.transform.options.TemporalSourceOptions
TemporalSourceOptions(TemporalSourceOptions) - Constructor for class org.gytheio.content.transform.options.TemporalSourceOptions
TemporalSourceOptions.TemporalSourceOptionsSerializer - Class in org.gytheio.content.transform.options: Serializer for temporal source options
TemporalSourceOptions.TemporalSourceOptionsSerializer() - Constructor for class org.gytheio.content.transform.options.TemporalSourceOptions.TemporalSourceOptionsSerializer
throwIOExceptionIfRequired(String, TransformerDebug) - Method in enum org.gytheio.content.transform.options.TransformationOptionPair.Action
TIME_MESSAGE - Static variable in class org.gytheio.content.transform.options.TransformationOptionLimits
TimecodeUtils - Class in org.gytheio.content.transform.util: Utility class for handling timecode strings
TimecodeUtils() - Constructor for class org.gytheio.content.transform.util.TimecodeUtils
toMap(Map<String, Object>) - Method in class org.gytheio.content.transform.options.TransformationOptionLimits
toMap(Map<String, Object>, String, String) - Method in class org.gytheio.content.transform.options.TransformationOptionPair
toString() - Method in class org.gytheio.content.transform.AbstractContentTransformerWorker
toString() - Method in class org.gytheio.content.transform.options.AbstractTransformationSourceOptions
toString() - Method in class org.gytheio.content.transform.options.AudioTransformationOptions
toString() - Method in class org.gytheio.content.transform.options.ImageResizeOptions
toString() - Method in class org.gytheio.content.transform.options.ImageTransformationOptions
toString() - Method in class org.gytheio.content.transform.options.TransformationOptionLimits
toString(String, String) - Method in class org.gytheio.content.transform.options.TransformationOptionPair
toString() - Method in class org.gytheio.content.transform.options.TransformationOptionsImpl
toString() - Method in class org.gytheio.content.transform.options.VideoTransformationOptions
toStringSourceOptions() - Method in class org.gytheio.content.transform.options.TransformationOptionsImpl: Builds the source options to string.
transform(List<ContentReference>, List<ContentReference>, TransformationOptions, ContentTransformerWorkerProgressReporter) - Method in class org.gytheio.content.transform.AbstractFileContentTransformerWorker
transform(List<ContentReference>, String, TransformationOptions, ContentTransformerWorkerProgressReporter) - Method in class org.gytheio.content.transform.AbstractFileContentTransformerWorker
transform(List<ContentReference>, List<ContentReference>, TransformationOptions, ContentTransformerWorkerProgressReporter) - Method in interface org.gytheio.content.transform.ContentTransformerWorker: Transforms the given source content references into the given target content references with the given options, reporting back via the given progress reporter.
transform(List<ContentReference>, String, TransformationOptions, ContentTransformerWorkerProgressReporter) - Method in interface org.gytheio.content.transform.ContentTransformerWorker: Transforms the given source content references into target content references created by the worker based on the given media type with the given options, reporting back via the given progress reporter.
TransformationOptionLimits - Class in org.gytheio.content.transform.options: Represents maximum source values (that result in exceptions if exceeded) or limits on source values (that result in EOF (End Of File) being returned early).
TransformationOptionLimits() - Constructor for class org.gytheio.content.transform.options.TransformationOptionLimits
TransformationOptionPair - Class in org.gytheio.content.transform.options: A pair of transformation options that specify A) a max value over which the source is not read (throws an Exception) or B) a limit over which no more of the source is read (returns EOF) Each pair represents a values such as an elapse time, KBytes read or number of pages read.
TransformationOptionPair() - Constructor for class org.gytheio.content.transform.options.TransformationOptionPair
TransformationOptionPair.Action - Enum in org.gytheio.content.transform.options: Action to take place for a given pair of values.
TransformationOptions - Interface in org.gytheio.content.transform.options: Interface defining values of options that are passed to content transformers.
TransformationOptionsImpl - Class in org.gytheio.content.transform.options: Concrete implementation of transformation options
TransformationOptionsImpl() - Constructor for class org.gytheio.content.transform.options.TransformationOptionsImpl
TransformationOptionsImpl(TransformationOptionsImpl) - Constructor for class org.gytheio.content.transform.options.TransformationOptionsImpl
TransformationSourceOptions - Interface in org.gytheio.content.transform.options: Defines options and demarcations needed to describe the details of how the source should be transformed, independent of the target requirements.
TransformationSourceOptions.TransformationSourceOptionsSerializer - Interface in org.gytheio.content.transform.options: Defines methods for serializing the source options into a parameter map and deserializing from a serialized options accessor.
TransformerDebug - Interface in org.gytheio.content.transform: Generates logging for transformers.
transformInternal(List<AbstractFileContentTransformerWorker.FileContentReferencePair>, List<AbstractFileContentTransformerWorker.FileContentReferencePair>, TransformationOptions, ContentTransformerWorkerProgressReporter) - Method in class org.gytheio.content.transform.AbstractFileContentTransformerWorker: Transforms the given source file to the given target file and media type using the given transformation options and reports progress via the given progress reporter.

V

validateTimeString(String) - Static method in class org.gytheio.content.transform.options.TemporalSourceOptions: Validates that the given value is of the form hh:mm:ss[.xxx]
valueOf(String) - Static method in enum org.gytheio.content.transform.options.TransformationOptionPair.Action: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.gytheio.content.transform.options.TransformationOptionPair.Action: Returns an array containing the constants of this enum type, in the order they are declared.
VAR_SOURCE - Static variable in class org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker: source variable name
VAR_TARGET - Static variable in class org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker: target variable name
versionDetailsExecuter - Variable in class org.gytheio.content.transform.AbstractRuntimeExecContentTransformerWorker: the check command executer
VIDEO_CODEC_H264 - Static variable in class org.gytheio.content.transform.options.VideoTransformationOptions
VIDEO_CODEC_MPEG4 - Static variable in class org.gytheio.content.transform.options.VideoTransformationOptions
VIDEO_CODEC_PASSTHROUGH - Static variable in class org.gytheio.content.transform.options.VideoTransformationOptions
VIDEO_CODEC_THEORA - Static variable in class org.gytheio.content.transform.options.VideoTransformationOptions
VIDEO_CODEC_VP6 - Static variable in class org.gytheio.content.transform.options.VideoTransformationOptions
VIDEO_CODEC_VP7 - Static variable in class org.gytheio.content.transform.options.VideoTransformationOptions
VIDEO_CODEC_VP8 - Static variable in class org.gytheio.content.transform.options.VideoTransformationOptions
VIDEO_CODEC_WMV - Static variable in class org.gytheio.content.transform.options.VideoTransformationOptions
VideoTransformationOptions - Class in org.gytheio.content.transform.options: Options relating to video transformations
VideoTransformationOptions() - Constructor for class org.gytheio.content.transform.options.VideoTransformationOptions
VideoTransformationOptions(VideoTransformationOptions) - Constructor for class org.gytheio.content.transform.options.VideoTransformationOptions

A C D E F G H I K L M O P R S T V