001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one
003     * or more contributor license agreements. See the NOTICE file
004     * distributed with this work for additional information
005     * regarding copyright ownership. The ASF licenses this file
006     * to you under the Apache License, Version 2.0 (the  "License");
007     * you may not use this file except in compliance with the License.
008     * You may obtain a copy of the License at
009     *
010     *     http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing, software
013     * distributed under the License is distributed on an "AS IS" BASIS,
014     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015     * See the License for the specific language governing permissions and
016     * limitations under the License.
017     */
018    /*
019     * $Id: DTMWSFilter.java 468653 2006-10-28 07:07:05Z minchau $
020     */
021    package org.apache.xml.dtm;
022    
023    /**
024     * This interface is meant to be implemented by a client of the DTM, and allows
025     * stripping of whitespace nodes.
026     */
027    public interface DTMWSFilter
028    {
029      /**
030       * Do not strip whitespace child nodes of this element.
031       */
032      public static final short NOTSTRIP = 1;
033    
034      /**
035       * Strip whitespace child nodes of this element.
036       */
037      public static final short STRIP = 2;
038    
039      /**
040       * Inherit whitespace stripping behavior of the parent node.
041       */
042      public static final short INHERIT = 3;
043    
044      /**
045       * Test whether whitespace-only text nodes are visible in the logical 
046       * view of <code>DTM</code>. Normally, this function
047       * will be called by the implementation of <code>DTM</code>; 
048       * it is not normally called directly from
049       * user code.
050       * 
051       * @param elementHandle int Handle of the element.
052       * @return one of NOTSTRIP, STRIP, or INHERIT.
053       */
054      public short getShouldStripSpace(int elementHandle, DTM dtm);
055      
056    }