MONK : CollectionManager Calls

This page last changed on Jan 13, 2009 by amitku.

getAuthorLost

Returns the list of all the authors

/get/CorpusManager.getAuthorList

getCollections

Returns the list of all the collections

/get/CorpusManager.getCorpora

getWorkList

/get/CorpusManager.getWorkList?corpus=ncf&start=0&end=10&sortby=pub_date_start_asc

The numWorkPart attribute is missing in the image -but it is implemented and gives the number of
workparts present in the the work

Request parameters Required.

collectionId
start
end
sortby : Any of the tokens below {title_asc|title_desc|pub_date_start_asc|pub_date_start_desc|pub_date_end_asc|pub_date_end_desc|num_word_asc|num_word_desc|num_author_asc|num_author_desc}

getWorksContainingFeature

/get/CorpusManager.getWorksWithFeature

All criterion are optional except corpusCriterion.

Request Attributes
lemmaPatternCriterion
corpusCriterion
pubDateStart
pubDateStartEnd
posCriterion
start
end (-1 will return all the documents)
sortby : Any of the tokens below {title_asc|title_desc|pub_date_start_asc|pub_date_start_desc|pub_date_end_asc|pub_date_end_desc|num_word_asc|num_word_desc|num_author_asc|num_author_desc}

Corpus Criterion

/get/CorpusManager.getWorksWithFeature?corpusCriterion=ncf&start=0&end=-1&sortby=pub_date_start_asc

Publication Start/End Date

/get/CorpusManager.getWorksWithFeature?corpusCriterion=ncf&pubDateStart=1895

POS Criterion

/get/CorpusManager.getWorksWithFeature?corpusCriterion=ncf&posCriterion=fw-it

Lemma Pattern Criterion

/get/CorpusManager.getWorksWithFeature?corpusCriterion=ncf&lemmaPatternCriterion=hate

h3. getWork

/get/CorpusManager.getWork?id=ncf-22501&format=html

Returns the entire work (or workpart).

Request Parameters
id (work ID or workpart ID)
format (optional, defaults to HTML) Options: "html" "xml" "xmlAdorned"

h3. getWorkInfo

/get/CorpusManager.getWorkInfo?corpus=ncf&id=ncf-22501

notice the numWorkPart attribute - This gives the number of workparts present in the work.

Request Parameters
corpus (collection ID)
id (work ID or workpart ID)


<workparts totalCount="8" start="0" end="8">
    <workpart id="ncf-22501-title" numWorkPart="0" numChildren="0" numWords="0" numWordsCum="0" level="1" workOrdinal="1" count="1">
        <label>Title</label>
    </workpart>
    <workpart id="ncf-22501-1" numWorkPart="0" numChildren="0" numWords="58" numWordsCum="58" level="1" workOrdinal="2" count="2">
        <label>PREFACE.</label>
    </workpart>
    ...
</workpart>

getNGramList

Request Parameters

id workpart or work id
num "2" or "3" for bigram/trigram
feature Spelling or Lemma

Spelling

Lemma

TriGram Patterns: getTriGramPatternList

url: /get/CorpusManager.getTriGramPatternList

Request Parameters

id workpart or work id
feature Lemma or Spelling
tag1 The first Lemma or Spelling.
tag2 The Second Lemma or Spelling. Optional
tag3 The Third Lemma or Spelling. Optional
position1 The lemma or spelling position that is empty. Optional if tag1 tag2 and tag3 are all provided
position2 The Lemma or spelling position that is empty. Optional if tag1, tag2 and tag3 are all provided or if tag1 and tag2 are provided

Pattern: Little * *

/get/CorpusManager.getTriGramPatternList?id=ncf-22501&feature=Spelling&tag1=little&position1=2&position2=3

This will return all the trigrams that have little in them and second, third spellings could be anything
-for example little Bob I, little Bob in, little Fan returned ...

Pattern: The Little *

Suppose you want all the trigrams that start with the little ;Use the call below

Note: &position1=3 and &tag1=the&tag2=little

/get/CorpusManager.getTriGramPatternList?id=ncf-22501&feature=Spelling&tag1=the&tag2=little&position1=3

Pattern: * little *

The call below will return all the trigrams that have little as spelling in the middle. It will be preceded
and succeeded by any other word.
Note: &position1=1&position2=3

/get/CorpusManager.getTriGramPatternList?id=ncf-22501&feature=Spelling&tag1=little&position1=1&position2=3

BiGram patterns: getBiGramPatternList

Request Parameters

id work or workpart id
tag1 The first spelling Lemma
tag2 The second spelling/lemma
end True or False used only in conjunction with tag1 and when tag2 parameter is not used. Denotes of the tag1 is second word or not.

Pattern: little or little

To get the spelling bigrams that have little in them (either as a first word or as a second word)
/get/CorpusManager.getBiGramPatternList?id=ncf-22501&feature=Spelling&tag1=little