I'm afraid the docs are not covering each and every aspect of uimaFIT.
It's intentional with the background that uimaFIT needs to be released soon
because we have other products are waiting on it. The documentation should be 
improved in future releases, as should be the educational value of the examples.

There is a mention of the new class in the migration guide which is part of the
HTML/PDF docs. I wonder why you didn't find that:

> XWriter removed. The XWriter and associated file namers have been removed as 
> they were much more complex then acutally needed. As an alternative, 
> CasIOUtil has been introduced providing several convenience methods to 
> read/write JCas/CAS data.

Mind, we have seen in the past that there's also the occasional undocumented
class in UIMA-SDK ;) Something we should also work on in the future.

-- Richard

Am 27.08.2013 um 16:00 schrieb Marshall Schor <[email protected]>:

> I searched the rc3 docs for mention of CasIOUtil, but didn't get a hit.  Is 
> this
> something that's overlooked, or intentional?
> 
> -Marshall
> 
> 
> On 8/25/2013 5:42 AM, Richard Eckart de Castilho (JIRA) wrote:
>>     [ 
>> https://issues.apache.org/jira/browse/UIMA-3219?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
>>  ]
>> 
>> Richard Eckart de Castilho resolved UIMA-3219.
>> ----------------------------------------------
>> 
>>    Resolution: Fixed
>> 
>> The new class is called CasIOUtil and handles JCas and CAS. Corresponding 
>> methods from JCasFactory have been moved/renamed.
>> 
>>> Simpler XMI writing than XWriter
>>> --------------------------------
>>> 
>>>                Key: UIMA-3219
>>>                URL: https://issues.apache.org/jira/browse/UIMA-3219
>>>            Project: UIMA
>>>         Issue Type: Improvement
>>>         Components: uimaFIT
>>>           Reporter: Steven Bethard
>>>           Assignee: Richard Eckart de Castilho
>>>            Fix For: 2.0.0uimaFIT
>>> 
>>> 
>>> The whole FileNamer thing in XWriter is more complexity than most users 
>>> need. You have to declare a new FileNamer class every time you create an 
>>> XWriter. But that FileNamer class, even though it takes a JCas just like an 
>>> annotator would, isn't actually an annotator, it's a totally different API.
>>> We should instead leverage our users' existing understanding of the 
>>> annotator API. If they're going to have to write a new class every time, we 
>>> should let them write an annotator class like they're already used to. We 
>>> should provide a simple static method that makes it easy to write such a 
>>> class, something like:
>>> {noformat}
>>> public class XUtil {
>>>     public static void writeXMI(JCas jCas, File outputFile) throws 
>>> IOException, SAXException {
>>>             FileOutputStream outputStream = new 
>>> FileOutputStream(outputFile);
>>>             try {
>>>                     ContentHandler handler = new 
>>> XMLSerializer(outputStream).getContentHandler();
>>>                     XmiCasSerializer serializer = new 
>>> XmiCasSerializer(jCas.getTypeSystem());
>>>                     serializer.serialize(jCas.getCas(), handler);
>>>             }
>>>             finally {
>>>                     outputStream.close();
>>>             }
>>>     }
>>> }
>>> {noformat}
>>> (The new XUtil class could also grow methods for writing XCAS, and for 
>>> reading XMI and XCAS.)
>>> More discussion here: https://code.google.com/p/uimafit/issues/detail?id=121
>> --
>> This message is automatically generated by JIRA.
>> If you think it was sent incorrectly, please contact your JIRA administrators
>> For more information on JIRA, see: http://www.atlassian.com/software/jira
>> 
> 

Reply via email to