KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > alfresco > service > cmr > view > ExporterCrawlerParameters


1 /*
2  * Copyright (C) 2005 Alfresco, Inc.
3  *
4  * Licensed under the Mozilla Public License version 1.1
5  * with a permitted attribution clause. You may obtain a
6  * copy of the License at
7  *
8  * http://www.alfresco.org/legal/license.txt
9  *
10  * Unless required by applicable law or agreed to in writing,
11  * software distributed under the License is distributed on an
12  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
13  * either express or implied. See the License for the specific
14  * language governing permissions and limitations under the
15  * License.
16  */
17 package org.alfresco.service.cmr.view;
18
19 import org.alfresco.service.namespace.NamespaceService;
20
21
22 /**
23  * Exporter Crawler Configuration.
24  *
25  * This class is used to specify which Repository items are exported.
26  *
27  * @author David Caruana
28  */
29 public class ExporterCrawlerParameters
30 {
31
32     private Location exportFrom = null;
33     private boolean crawlSelf = false;
34     private boolean crawlChildNodes = true;
35     private boolean crawlAssociations = true;
36     private boolean crawlContent = true;
37     private boolean crawlNullProperties = true;
38     private String JavaDoc[] excludeNamespaceURIs = new String JavaDoc[] { NamespaceService.REPOSITORY_VIEW_1_0_URI };
39
40     
41     /**
42      * Crawl and export child nodes
43      *
44      * @return true => crawl child nodes
45      */
46     public boolean isCrawlChildNodes()
47     {
48         return crawlChildNodes;
49     }
50
51     /**
52      * Sets whether to crawl child nodes
53      *
54      * @param crawlChildNodes
55      */
56     public void setCrawlChildNodes(boolean crawlChildNodes)
57     {
58         this.crawlChildNodes = crawlChildNodes;
59     }
60
61     /**
62      * Crawl and export associations
63      *
64      * @return true => crawl associations
65      */
66     public boolean isCrawlAssociations()
67     {
68         return crawlAssociations;
69     }
70     
71     /**
72      * Sets whether to crawl associations
73      *
74      * @param crawlAssociations
75      */
76     public void setCrawlAssociations(boolean crawlAssociations)
77     {
78         this.crawlAssociations = crawlAssociations;
79     }
80     
81     /**
82      * Crawl and export content properties
83      *
84      * @return true => crawl content
85      */
86     public boolean isCrawlContent()
87     {
88         return crawlContent;
89     }
90
91     /**
92      * Sets whether to crawl content
93      *
94      * @param crawlContent
95      */
96     public void setCrawlContent(boolean crawlContent)
97     {
98         this.crawlContent = crawlContent;
99     }
100
101     /**
102      * Crawl and export node at export path
103      *
104      * @return true => crawl node at export path
105      */
106     public boolean isCrawlSelf()
107     {
108         return crawlSelf;
109     }
110
111     /**
112      * Sets whether to crawl and export node at export path
113      *
114      * @param crawlSelf
115      */
116     public void setCrawlSelf(boolean crawlSelf)
117     {
118         this.crawlSelf = crawlSelf;
119     }
120
121     /**
122      * Crawl and export null properties
123      *
124      * @return true => export null properties
125      */
126     public boolean isCrawlNullProperties()
127     {
128         return crawlNullProperties;
129     }
130
131     /**
132      * Sets whether to crawl null properties
133      *
134      * @param crawlNullProperties
135      */
136     public void setCrawlNullProperties(boolean crawlNullProperties)
137     {
138         this.crawlNullProperties = crawlNullProperties;
139     }
140
141     /**
142      * Gets the list of namespace URIs to exlude from the Export
143      *
144      * @return the list of namespace URIs
145      */
146     public String JavaDoc[] getExcludeNamespaceURIs()
147     {
148         return excludeNamespaceURIs;
149     }
150
151     /**
152      * Sets the list of namespace URIs to exclude from the Export
153      *
154      * @param excludeNamespaceURIs
155      */
156     public void setExcludeNamespaceURIs(String JavaDoc[] excludeNamespaceURIs)
157     {
158         this.excludeNamespaceURIs = excludeNamespaceURIs;
159     }
160
161     /**
162      * Gets the path to export from
163      *
164      * @return the path to export from
165      */
166     public Location getExportFrom()
167     {
168         return exportFrom;
169     }
170
171     /**
172      * Sets the path to export from
173      *
174      * @param exportFrom
175      */
176     public void setExportFrom(Location exportFrom)
177     {
178         this.exportFrom = exportFrom;
179     }
180
181 }
182
Popular Tags