xmlenc-devel

[xmlenc-devel] XMLStream

[Pete C. <pe...@fi...>]

Hi guys,

I'm mostly just trying out the mailing list.

One question for Ernst: why did you name the class XMLStream instead of
XMLWriter? I think the latter is more appropriate, as you're obviously
using a Writer internally. For example, you have a getWriter() method
but no getStream() method.

If you're worried about conflicting with the name of our XmlWriter, I
don't think we need to worry about that. We should just choose the best
name. Anyway, we used different capitalization in XmlWriter.

Your proposal of setEscaping() and isEscaping() seems fine to me, though
I haven't encountered a need for this capability myself. If it seems
generally useful though, go ahead.

I didn't understand why you are planning this:

> I would like to introduce a new class that is responsible only for the
> different types of output (raw, PCDATA with char entity replacements,
> attribute values, etc).

Could you elaborate on this thought some time?

Gratefully,

Pete Cassetta
pe...@fi...

-------------------------------------------
Fingertip Software
433 Kitty Hawk Rd., Suite 216
P.O. Box 2487
Universal City, TX 78148

Orders:  (800) 209-4063 -or- (210) 659-6832
Support: (210) 659-2532
Fax:     (210) 659-8870

http://www.fingertipsoft.com
-------------------------------------------

[xmlenc-devel] New class responsible for output (Was: XMLStream)

[Ernst de H. <zn...@Fr...>]

> I didn't understand why you are planning this:
> > I would like to introduce a new class that is responsible only for the
> > different types of output (raw, PCDATA with char entity replacements,
> > attribute values, etc).
>
> Could you elaborate on this thought some time?

Currently the main class (XMLStream, previously XMLEncoder) inheritance 
chain is based on the low-level, encoding-specific, output characteristics. 
There are 2 subclasses, one for Unicode encodings and one for ASCII-based 
encodings.

If the main class should be extensible in terms of functionality or 
behaviour, then a new class should be introduced to encapsulate the 
low-level output characteristics. Then the main class will delegate that to 
this new class.

Ernst

-- 
Ernst de Haan
Development Team Leader
Wanadoo Nederland B.V.

    "Come to me all who are weary and burdened
        and I will give you rest" -- Jesus Christ

[xmlenc-devel] Escaping (Was: XMLStream)

[Ernst de H. <zn...@Fr...>]

> Your proposal of setEscaping() and isEscaping() seems fine to me, though
> I haven't encountered a need for this capability myself. If it seems
> generally useful though, go ahead.

The problem is that entity references cannot be printed in attribute values 
nor in comments.

After reconsideration, here's an improved (IMO) proposal.

* setEscaping(boolean enable)
  Enables or disables escaping of ampersands. If entity references should be
  printed, then escaping should be disabled. This setting applies to
  pcdata(String), whitespace(String) and to the attribute value passed to
  attribute(String,String).
  See: isEscaping()

* isEscaping()


Ernst

-- 
Ernst de Haan
Development Team Leader
Wanadoo Nederland B.V.

    "Come to me all who are weary and burdened
        and I will give you rest" -- Jesus Christ

Re: [xmlenc-devel] XMLStream

[Ernst de H. <zn...@Fr...>]

> One question for Ernst: why did you name the class XMLStream instead of
> XMLWriter? I think the latter is more appropriate, as you're obviously
> using a Writer internally. For example, you have a getWriter() method
> but no getStream() method.

The fact that the class uses a Writer internally has IMHO no impact on the 
name of the class. I could use an OutputStream instead of a Writer without 
affecting the name.

I couldn't really find a single name that matches the class's function the 
best. Some alternatives:

a. XMLEncoder
b. XMLStream
c. XMLOutputter
d. XMLPrinter
e. XMLWriter
f. XMLGenerator

What if we just stay with XMLStream? Is there an appelling reason to use a 
different name? Is is considered inappropriate or confusing? If so, then we 
should change it, otherwise I think we should just leave it as it is.

[ I will react to your other queries in separate emails, to keep the threads
  subject-specific ]

Regards,


Ernst

-- 
Ernst de Haan
Development Team Leader
Wanadoo Nederland B.V.

    "Come to me all who are weary and burdened
        and I will give you rest" -- Jesus Christ