View Javadoc
1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *  
10   *    http://www.apache.org/licenses/LICENSE-2.0
11   *  
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License. 
18   *  
19   */
20  package org.apache.directory.api.dsmlv2.request;
21  
22  
23  import java.util.ArrayList;
24  import java.util.List;
25  
26  import org.apache.directory.api.asn1.DecoderException;
27  
28  
29  /**
30   * This Filter abstract class is used to store a set of filters used by
31   * OR/AND/NOT filters.
32   * 
33   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
34   */
35  public abstract class ConnectorFilter extends Filter
36  {
37      /** The set of filters used by And/Or filters */
38      protected List<Filter> filterSet;
39  
40  
41      /**
42       * Add a new Filter to the list.
43       * 
44       * @param filter The filter to add
45       * @throws DecoderException If the added filter is invalid
46       */
47      public void addFilter( Filter filter ) throws DecoderException
48      {
49  
50          if ( filterSet == null )
51          {
52              filterSet = new ArrayList<Filter>();
53          }
54  
55          filterSet.add( filter );
56      }
57  
58  
59      /**
60       * Get the list of filters stored in the composite filter
61       * 
62       * @return And array of filters
63       */
64      public List<Filter> getFilterSet()
65      {
66          return filterSet;
67      }
68  
69  
70      /**
71       * Return a string compliant with RFC 2254 representing a composite filter,
72       * one of AND, OR and NOT
73       * 
74       * @return The composite filter string
75       */
76      public String toString()
77      {
78          StringBuffer sb = new StringBuffer();
79  
80          if ( ( filterSet != null ) && ( filterSet.size() != 0 ) )
81          {
82              for ( Filter filter : filterSet )
83              {
84                  sb.append( '(' ).append( filter ).append( ')' );
85              }
86          }
87  
88          return sb.toString();
89      }
90  }