CLAM
stable
Introduction
Installation
Getting Started
Service configuration
Wrapper script
Deployment in production
Clients
Troubleshooting
RESTful API specification
CLAM
Docs
»
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
X
|
Z
A
abort() (clam.common.client.CLAMClient method)
AbstractConverter (class in clam.common.data)
,
[1]
AbstractMetaField (class in clam.common.data)
,
[1]
AbstractParameter (class in clam.common.parameters)
,
[1]
AbstractViewer (class in clam.common.viewers)
acceptforinput (clam.common.converters.CharEncodingConverter attribute)
(clam.common.converters.MSWordConverter attribute)
(clam.common.converters.PDFtoHTMLConverter attribute)
(clam.common.converters.PDFtoTextConverter attribute)
(clam.common.data.AbstractConverter attribute)
,
[1]
acceptforoutput (clam.common.converters.CharEncodingConverter attribute)
(clam.common.data.AbstractConverter attribute)
,
[1]
access() (clam.common.parameters.AbstractParameter method)
,
[1]
Action (class in clam.common.data)
,
[1]
action() (clam.common.client.CLAMClient method)
add() (clam.common.data.Program method)
,
[1]
addinput() (clam.common.client.CLAMClient method)
addinputfile() (clam.common.client.CLAMClient method)
allowcustomattributes (clam.common.data.CLAMMetaData attribute)
,
[1]
(clam.common.formats.ExampleFormat attribute)
allowusers (clam.common.parameters.AbstractParameter attribute)
,
[1]
allpossibilities() (clam.common.data.ParameterCondition method)
,
[1]
AlpinoXMLFormat (class in clam.common.formats)
attachviewers() (clam.common.data.CLAMFile method)
,
[1]
attributes (clam.common.data.CLAMMetaData attribute)
,
[1]
(clam.common.formats.AlpinoXMLFormat attribute)
(clam.common.formats.BinaryDataFormat attribute)
(clam.common.formats.CSVFormat attribute)
(clam.common.formats.DCOIFormat attribute)
(clam.common.formats.DjVuFormat attribute)
(clam.common.formats.ExampleFormat attribute)
(clam.common.formats.FoLiAXMLFormat attribute)
(clam.common.formats.FrogTSVFormat attribute)
(clam.common.formats.GifImageFormat attribute)
(clam.common.formats.HTMLFormat attribute)
(clam.common.formats.JpegImageFormat attribute)
(clam.common.formats.MP3AudioFormat attribute)
(clam.common.formats.MSWordFormat attribute)
(clam.common.formats.MpegVideoFormat attribute)
(clam.common.formats.OggAudioFormat attribute)
(clam.common.formats.OggVideoFormat attribute)
(clam.common.formats.OpenDocumentTextFormat attribute)
(clam.common.formats.PDFFormat attribute)
(clam.common.formats.PlainTextFormat attribute)
(clam.common.formats.PngImageFormat attribute)
(clam.common.formats.TiffImageFormat attribute)
(clam.common.formats.WaveAudioFormat attribute)
(clam.common.formats.XMLStyleSheet attribute)
(clam.common.formats.ZIPFormat attribute)
AuthenticationRequired
,
[1]
AuthRequired
,
[1]
B
BadRequest
,
[1]
basedir (clam.common.data.CLAMFile attribute)
,
[1]
(clam.common.data.CLAMInputFile attribute)
,
[1]
(clam.common.data.CLAMOutputFile attribute)
,
[1]
baseurl (clam.common.data.CLAMData attribute)
,
[1]
BinaryDataFormat (class in clam.common.formats)
BooleanParameter (class in clam.common.parameters)
,
[1]
buildarchive() (in module clam.common.data)
,
[1]
C
CharEncodingConverter (class in clam.common.converters)
check() (clam.common.data.InputSource method)
,
[1]
ChoiceParameter (class in clam.common.parameters)
,
[1]
clam.common.client (module)
clam.common.converters (module)
clam.common.data (module)
,
[1]
clam.common.formats (module)
clam.common.parameters (module)
,
[1]
clam.common.viewers (module)
CLAMClient (class in clam.common.client)
CLAMData (class in clam.common.data)
,
[1]
CLAMFile (class in clam.common.data)
,
[1]
CLAMInputFile (class in clam.common.data)
,
[1]
CLAMMetaData (class in clam.common.data)
,
[1]
CLAMOutputFile (class in clam.common.data)
,
[1]
CLAMProvenanceData (class in clam.common.data)
,
[1]
commandlineargs() (clam.common.data.CLAMData method)
,
[1]
compilearg() (clam.common.parameters.AbstractParameter method)
,
[1]
(clam.common.parameters.BooleanParameter method)
,
[1]
(clam.common.parameters.ChoiceParameter method)
,
[1]
(clam.common.parameters.StringParameter method)
,
[1]
(clam.common.parameters.TextParameter method)
,
[1]
ConfigurationError
,
[1]
constrainable() (clam.common.parameters.AbstractParameter method)
,
[1]
(clam.common.parameters.BooleanParameter method)
,
[1]
(clam.common.parameters.FloatParameter method)
,
[1]
(clam.common.parameters.IntegerParameter method)
,
[1]
Constraint (class in clam.common.data)
,
[1]
convertforinput() (clam.common.converters.CharEncodingConverter method)
(clam.common.converters.MSWordConverter method)
(clam.common.converters.PDFtoHTMLConverter method)
(clam.common.converters.PDFtoTextConverter method)
(clam.common.data.AbstractConverter method)
,
[1]
convertforoutput() (clam.common.converters.CharEncodingConverter method)
(clam.common.data.AbstractConverter method)
,
[1]
converttool (clam.common.converters.MSWordConverter attribute)
(clam.common.converters.PDFtoHTMLConverter attribute)
(clam.common.converters.PDFtoTextConverter attribute)
copy() (clam.common.data.CLAMFile method)
,
[1]
CopyMetaField (class in clam.common.data)
,
[1]
corpora (clam.common.data.CLAMData attribute)
,
[1]
create() (clam.common.client.CLAMClient method)
CSVFormat (class in clam.common.formats)
D
DCOIFormat (class in clam.common.formats)
delete() (clam.common.client.CLAMClient method)
(clam.common.data.CLAMFile method)
,
[1]
denyusers (clam.common.parameters.AbstractParameter attribute)
,
[1]
description (clam.common.parameters.AbstractParameter attribute)
,
[1]
DjVuFormat (class in clam.common.formats)
donereadingupload() (in module clam.common.client)
download() (clam.common.client.CLAMClient method)
downloadarchive() (clam.common.client.CLAMClient method)
downloadstorage() (clam.common.client.CLAMClient method)
E
error (clam.common.parameters.AbstractParameter attribute)
,
[1]
errormsg (clam.common.data.CLAMData attribute)
,
[1]
errors (clam.common.data.CLAMData attribute)
,
[1]
escape() (in module clam.common.data)
,
[1]
escapeshelloperators() (in module clam.common.data)
,
[1]
evaluate() (clam.common.data.ParameterCondition method)
,
[1]
ExampleFormat (class in clam.common.formats)
exists() (clam.common.data.CLAMFile method)
,
[1]
F
findparent() (clam.common.data.OutputTemplate method)
,
[1]
FLATViewer (class in clam.common.viewers)
FloatParameter (class in clam.common.parameters)
,
[1]
FoLiAViewer (class in clam.common.viewers)
FoLiAXMLFormat (class in clam.common.formats)
ForbidMeta (class in clam.common.data)
,
[1]
FormatError
,
[1]
formatxml() (clam.common.data.CLAMMetaData class method)
,
[1]
Forwarder (class in clam.common.data)
,
[1]
ForwardViewer (class in clam.common.viewers)
FrogTSVFormat (class in clam.common.formats)
fromxml() (clam.common.data.AbstractMetaField static method)
,
[1]
(clam.common.data.Action static method)
,
[1]
(clam.common.data.CLAMMetaData static method)
,
[1]
(clam.common.data.CLAMProvenanceData static method)
,
[1]
(clam.common.data.Constraint static method)
,
[1]
(clam.common.data.InputTemplate static method)
,
[1]
(clam.common.data.OutputTemplate static method)
,
[1]
(clam.common.data.ParameterCondition static method)
,
[1]
(clam.common.data.Profile static method)
,
[1]
(clam.common.parameters.AbstractParameter static method)
,
[1]
G
generate() (clam.common.data.InputTemplate method)
,
[1]
(clam.common.data.OutputTemplate method)
,
[1]
(clam.common.data.Profile method)
,
[1]
generatemetadata() (clam.common.data.OutputTemplate method)
,
[1]
get() (clam.common.client.CLAMClient method)
(clam.common.data.CLAMData method)
,
[1]
getclamdata() (in module clam.common.data)
,
[1]
getformats() (in module clam.common.data)
,
[1]
getinputfile() (clam.common.data.Program method)
,
[1]
getinputfilename() (clam.common.client.CLAMClient method)
getinputfiles() (clam.common.data.Program method)
,
[1]
getoutputfile() (clam.common.data.Program method)
,
[1]
getoutputfiles() (clam.common.data.Program method)
,
[1]
getparent() (clam.common.data.OutputTemplate method)
,
[1]
getroot() (clam.common.client.CLAMClient method)
GifImageFormat (class in clam.common.formats)
H
HTMLFormat (class in clam.common.formats)
HTTPError
,
[1]
httpheaders() (clam.common.data.CLAMMetaData method)
,
[1]
(clam.common.formats.ExampleFormat method)
(clam.common.formats.HTMLFormat method)
(clam.common.formats.PlainTextFormat method)
I
id (clam.common.parameters.AbstractParameter attribute)
,
[1]
(clam.common.viewers.AbstractViewer attribute)
(clam.common.viewers.FLATViewer attribute)
(clam.common.viewers.FoLiAViewer attribute)
(clam.common.viewers.ShareViewer attribute)
(clam.common.viewers.SimpleTableViewer attribute)
(clam.common.viewers.SoNaRViewer attribute)
(clam.common.viewers.XSLTViewer attribute)
index() (clam.common.client.CLAMClient method)
initauth() (clam.common.client.CLAMClient method)
initrequest() (clam.common.client.CLAMClient method)
input (clam.common.data.CLAMData attribute)
,
[1]
inputfile() (clam.common.data.CLAMData method)
,
[1]
inputfiles() (clam.common.data.CLAMData method)
,
[1]
inputpairs() (clam.common.data.Program method)
,
[1]
InputSource (class in clam.common.data)
,
[1]
InputTemplate (class in clam.common.data)
,
[1]
inputtemplate() (clam.common.data.CLAMData method)
,
[1]
inputtemplates() (clam.common.data.CLAMData method)
,
[1]
IntegerParameter (class in clam.common.parameters)
,
[1]
isdir() (clam.common.data.InputSource method)
,
[1]
isfile() (clam.common.data.InputSource method)
,
[1]
items() (clam.common.data.CLAMMetaData method)
,
[1]
J
JpegImageFormat (class in clam.common.formats)
json() (clam.common.data.InputTemplate method)
,
[1]
JSONFormat (class in clam.common.formats)
K
KBXMLFormat (class in clam.common.formats)
L
label (clam.common.converters.CharEncodingConverter attribute)
(clam.common.data.AbstractConverter attribute)
,
[1]
loadconfig() (in module clam.common.data)
,
[1]
loadconfigfile() (in module clam.common.data)
,
[1]
loadmetadata (clam.common.data.CLAMData attribute)
,
[1]
loadmetadata() (clam.common.data.CLAMFile method)
,
[1]
M
match() (clam.common.data.InputTemplate method)
,
[1]
(clam.common.data.ParameterCondition method)
,
[1]
(clam.common.data.Profile method)
,
[1]
matchingfiles() (clam.common.data.InputTemplate method)
,
[1]
(clam.common.data.Profile method)
,
[1]
matchingprofiles() (clam.common.data.CLAMData method)
,
[1]
metafilename() (clam.common.data.CLAMFile method)
,
[1]
mimetype (clam.common.data.CLAMMetaData attribute)
,
[1]
(clam.common.formats.AlpinoXMLFormat attribute)
(clam.common.formats.BinaryDataFormat attribute)
(clam.common.formats.CSVFormat attribute)
(clam.common.formats.DCOIFormat attribute)
(clam.common.formats.DjVuFormat attribute)
(clam.common.formats.ExampleFormat attribute)
(clam.common.formats.FoLiAXMLFormat attribute)
(clam.common.formats.FrogTSVFormat attribute)
(clam.common.formats.GifImageFormat attribute)
(clam.common.formats.HTMLFormat attribute)
(clam.common.formats.JSONFormat attribute)
(clam.common.formats.JpegImageFormat attribute)
(clam.common.formats.KBXMLFormat attribute)
(clam.common.formats.MP3AudioFormat attribute)
(clam.common.formats.MSWordFormat attribute)
(clam.common.formats.MpegVideoFormat attribute)
(clam.common.formats.OggAudioFormat attribute)
(clam.common.formats.OggVideoFormat attribute)
(clam.common.formats.OpenDocumentTextFormat attribute)
(clam.common.formats.PDFFormat attribute)
(clam.common.formats.PlainTextFormat attribute)
(clam.common.formats.PngImageFormat attribute)
(clam.common.formats.TICCLShadowOutputXML attribute)
(clam.common.formats.TICCLVariantOutputXML attribute)
(clam.common.formats.TiffImageFormat attribute)
(clam.common.formats.WaveAudioFormat attribute)
(clam.common.formats.XMLFormat attribute)
(clam.common.formats.XMLStyleSheet attribute)
(clam.common.formats.ZIPFormat attribute)
(clam.common.viewers.AbstractViewer attribute)
MP3AudioFormat (class in clam.common.formats)
MpegVideoFormat (class in clam.common.formats)
MSWordConverter (class in clam.common.converters)
MSWordFormat (class in clam.common.formats)
N
name (clam.common.formats.AlpinoXMLFormat attribute)
(clam.common.formats.BinaryDataFormat attribute)
(clam.common.formats.CSVFormat attribute)
(clam.common.formats.DCOIFormat attribute)
(clam.common.formats.DjVuFormat attribute)
(clam.common.formats.FoLiAXMLFormat attribute)
(clam.common.formats.FrogTSVFormat attribute)
(clam.common.formats.GifImageFormat attribute)
(clam.common.formats.HTMLFormat attribute)
(clam.common.formats.JSONFormat attribute)
(clam.common.formats.JpegImageFormat attribute)
(clam.common.formats.KBXMLFormat attribute)
(clam.common.formats.MP3AudioFormat attribute)
(clam.common.formats.MSWordFormat attribute)
(clam.common.formats.MpegVideoFormat attribute)
(clam.common.formats.OggAudioFormat attribute)
(clam.common.formats.OggVideoFormat attribute)
(clam.common.formats.OpenDocumentTextFormat attribute)
(clam.common.formats.PDFFormat attribute)
(clam.common.formats.PlainTextFormat attribute)
(clam.common.formats.PngImageFormat attribute)
(clam.common.formats.TICCLShadowOutputXML attribute)
(clam.common.formats.TICCLVariantOutputXML attribute)
(clam.common.formats.TiffImageFormat attribute)
(clam.common.formats.WaveAudioFormat attribute)
(clam.common.formats.XMLFormat attribute)
(clam.common.formats.XMLStyleSheet attribute)
(clam.common.formats.ZIPFormat attribute)
(clam.common.parameters.AbstractParameter attribute)
,
[1]
(clam.common.viewers.AbstractViewer attribute)
(clam.common.viewers.FLATViewer attribute)
(clam.common.viewers.FoLiAViewer attribute)
(clam.common.viewers.ShareViewer attribute)
(clam.common.viewers.SimpleTableViewer attribute)
(clam.common.viewers.SoNaRViewer attribute)
(clam.common.viewers.XSLTViewer attribute)
NoConnection
,
[1]
NotFound
,
[1]
O
OggAudioFormat (class in clam.common.formats)
OggVideoFormat (class in clam.common.formats)
OpenDocumentTextFormat (class in clam.common.formats)
out() (clam.common.data.Profile method)
,
[1]
output (clam.common.data.CLAMData attribute)
,
[1]
outputpairs() (clam.common.data.Program method)
,
[1]
OutputTemplate (class in clam.common.data)
,
[1]
outputtemplate() (clam.common.data.CLAMData method)
,
[1]
outputtemplates() (clam.common.data.Profile method)
,
[1]
P
parameter() (clam.common.data.CLAMData method)
,
[1]
ParameterCondition (class in clam.common.data)
,
[1]
ParameterError
,
[1]
parametererror() (clam.common.data.CLAMData method)
,
[1]
ParameterMetaField (class in clam.common.data)
,
[1]
parameters (clam.common.data.CLAMData attribute)
,
[1]
paramflag (clam.common.parameters.AbstractParameter attribute)
,
[1]
parseresponse() (clam.common.data.CLAMData method)
,
[1]
parsexmlstring() (in module clam.common.data)
,
[1]
passparameters() (clam.common.data.CLAMData method)
,
[1]
PDFFormat (class in clam.common.formats)
PDFtoHTMLConverter (class in clam.common.converters)
PDFtoTextConverter (class in clam.common.converters)
PermissionDenied
,
[1]
PlainTextFormat (class in clam.common.formats)
PngImageFormat (class in clam.common.formats)
porch() (clam.common.client.CLAMClient method)
processhttpcode() (in module clam.common.data)
,
[1]
processparameter() (in module clam.common.data)
,
[1]
processparameters() (in module clam.common.data)
,
[1]
Profile (class in clam.common.data)
,
[1]
profiler() (in module clam.common.data)
,
[1]
profiles (clam.common.data.CLAMData attribute)
,
[1]
program (clam.common.data.CLAMData attribute)
,
[1]
Program (class in clam.common.data)
,
[1]
projects (clam.common.data.CLAMData attribute)
,
[1]
projecturl (clam.common.data.CLAMData attribute)
,
[1]
R
RawXMLProvenanceData (class in clam.common.data)
,
[1]
read() (clam.common.data.CLAMFile method)
,
[1]
(clam.common.viewers.SimpleTableViewer method)
readlines() (clam.common.data.CLAMFile method)
,
[1]
register_custom_formats() (clam.common.client.CLAMClient method)
register_custom_viewers() (clam.common.client.CLAMClient method)
request() (clam.common.client.CLAMClient method)
RequireMeta (class in clam.common.data)
,
[1]
resolve() (clam.common.data.AbstractMetaField method)
,
[1]
(clam.common.data.CopyMetaField method)
,
[1]
(clam.common.data.ParameterMetaField method)
,
[1]
(clam.common.data.SetMetaField method)
,
[1]
(clam.common.data.UnsetMetaField method)
,
[1]
resolveconfigvariables() (in module clam.common.data)
,
[1]
resolveinputfilename() (in module clam.common.data)
,
[1]
resolveoutputfilename() (in module clam.common.data)
,
[1]
S
sanitizeparameters() (in module clam.common.data)
,
[1]
save() (clam.common.data.CLAMMetaData method)
,
[1]
schema (clam.common.data.CLAMMetaData attribute)
,
[1]
(clam.common.formats.AlpinoXMLFormat attribute)
(clam.common.formats.DCOIFormat attribute)
(clam.common.formats.ExampleFormat attribute)
(clam.common.formats.FoLiAXMLFormat attribute)
(clam.common.formats.KBXMLFormat attribute)
(clam.common.formats.MSWordFormat attribute)
(clam.common.formats.TICCLShadowOutputXML attribute)
(clam.common.formats.TICCLVariantOutputXML attribute)
(clam.common.formats.XMLFormat attribute)
ServerError
,
[1]
set() (clam.common.parameters.AbstractParameter method)
,
[1]
(clam.common.parameters.BooleanParameter method)
,
[1]
(clam.common.parameters.ChoiceParameter method)
,
[1]
(clam.common.parameters.FloatParameter method)
,
[1]
(clam.common.parameters.IntegerParameter method)
,
[1]
SetMetaField (class in clam.common.data)
,
[1]
ShareViewer (class in clam.common.viewers)
shellsafe() (in module clam.common.data)
,
[1]
SimpleTableViewer (class in clam.common.viewers)
SoNaRViewer (class in clam.common.viewers)
start() (clam.common.client.CLAMClient method)
startsafe() (clam.common.client.CLAMClient method)
StaticParameter (class in clam.common.parameters)
,
[1]
status (clam.common.data.CLAMData attribute)
,
[1]
statusmessage (clam.common.data.CLAMData attribute)
,
[1]
store() (clam.common.data.CLAMFile method)
,
[1]
StringParameter (class in clam.common.parameters)
,
[1]
T
TadpoleFormat (in module clam.common.formats)
test() (clam.common.data.Constraint method)
,
[1]
TextParameter (class in clam.common.parameters)
,
[1]
TICCLShadowOutputXML (class in clam.common.formats)
TICCLVariantOutputXML (class in clam.common.formats)
TiffImageFormat (class in clam.common.formats)
TimeOut
,
[1]
U
UndefinedXMLFormat (in module clam.common.formats)
unescapeshelloperators() (in module clam.common.data)
,
[1]
unset() (clam.common.parameters.BooleanParameter method)
,
[1]
UnsetMetaField (class in clam.common.data)
,
[1]
update() (clam.common.data.Program method)
,
[1]
upload() (clam.common.client.CLAMClient method)
UploadError
,
[1]
V
validate() (clam.common.data.CLAMFile method)
,
[1]
(clam.common.data.CLAMMetaData method)
,
[1]
(clam.common.data.InputTemplate method)
,
[1]
(clam.common.parameters.AbstractParameter method)
,
[1]
(clam.common.parameters.ChoiceParameter method)
,
[1]
(clam.common.parameters.FloatParameter method)
,
[1]
(clam.common.parameters.IntegerParameter method)
,
[1]
(clam.common.parameters.StringParameter method)
,
[1]
validateconstraints() (clam.common.data.CLAMMetaData method)
,
[1]
validator() (clam.common.data.CLAMMetaData method)
,
[1]
(clam.common.formats.ExampleFormat method)
(clam.common.formats.FoLiAXMLFormat method)
valuefrompostdata() (clam.common.parameters.AbstractParameter method)
,
[1]
(clam.common.parameters.BooleanParameter method)
,
[1]
(clam.common.parameters.ChoiceParameter method)
,
[1]
(clam.common.parameters.FloatParameter method)
,
[1]
(clam.common.parameters.IntegerParameter method)
,
[1]
view() (clam.common.viewers.AbstractViewer method)
(clam.common.viewers.FLATViewer method)
(clam.common.viewers.FoLiAViewer method)
(clam.common.viewers.ForwardViewer method)
(clam.common.viewers.ShareViewer method)
(clam.common.viewers.SimpleTableViewer method)
(clam.common.viewers.SoNaRViewer method)
(clam.common.viewers.XSLTViewer method)
W
WaveAudioFormat (class in clam.common.formats)
X
xml() (clam.common.data.AbstractMetaField method)
,
[1]
(clam.common.data.Action method)
,
[1]
(clam.common.data.CLAMMetaData method)
,
[1]
(clam.common.data.CLAMProvenanceData method)
,
[1]
(clam.common.data.Constraint method)
,
[1]
(clam.common.data.CopyMetaField method)
,
[1]
(clam.common.data.InputSource method)
,
[1]
(clam.common.data.InputTemplate method)
,
[1]
(clam.common.data.OutputTemplate method)
,
[1]
(clam.common.data.ParameterCondition method)
,
[1]
(clam.common.data.ParameterMetaField method)
,
[1]
(clam.common.data.Profile method)
,
[1]
(clam.common.data.RawXMLProvenanceData method)
,
[1]
(clam.common.data.SetMetaField method)
,
[1]
(clam.common.data.UnsetMetaField method)
,
[1]
(clam.common.parameters.AbstractParameter method)
,
[1]
(clam.common.parameters.ChoiceParameter method)
,
[1]
(clam.common.viewers.AbstractViewer method)
XMLFormat (class in clam.common.formats)
XMLStyleSheet (class in clam.common.formats)
XSLTViewer (class in clam.common.viewers)
Z
ZIPFormat (class in clam.common.formats)
Read the Docs
v: stable
Versions
latest
stable
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.