1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
/*******************************************************************************
* Copyright (c) 2004 - 2006 University Of British Columbia and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* University Of British Columbia - initial API and implementation
*******************************************************************************/
package org.eclipse.mylar.tasklist;
import org.eclipse.mylar.internal.tasklist.TaskList;
import org.eclipse.mylar.internal.tasklist.TaskListExternalizerException;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
/**
* Used to externalize things like tasks and bug reports along with the task
* list so that information about them can be persisted across invocations.
*
* @author Mik Kersten
* @author Ken Sueda
*
* TODO: consider merging tasks and categories
*/
public interface ITaskListExternalizer {
public abstract ITaskRepositoryClient getRepositoryClient();
/**
* Note that registries get read as a normal category, but get written out
* first.
*/
public abstract void createRegistry(Document doc, Node parent);
public abstract String getCategoryTagName();
public abstract String getTaskTagName();
public abstract String getQueryTagNameForElement(IRepositoryQuery query);
public abstract String getQueryHitTagName();
public abstract boolean canCreateElementFor(ITaskCategory category);
/**
* @return the element that was created, null if failed
*/
public abstract Element createCategoryElement(ITaskCategory category, Document doc, Element parent);
public abstract boolean canCreateElementFor(ITask task);
/**
* @return the element that was created, null if failed
*/
public abstract Element createTaskElement(ITask task, Document doc, Element parent);
public abstract boolean canReadCategory(Node node);
public abstract void readCategory(Node node, TaskList tlist) throws TaskListExternalizerException;
public abstract boolean canReadTask(Node node);
public abstract ITask readTask(Node node, TaskList tlist, ITaskCategory category, ITask parent)
throws TaskListExternalizerException;
public abstract boolean canCreateElementFor(IRepositoryQuery category);
public abstract Element createQueryElement(IRepositoryQuery query, Document doc, Element parent);
public abstract boolean canReadQuery(Node node);
public abstract void readQuery(Node node, TaskList tlist) throws TaskListExternalizerException;
public abstract boolean canCreateElementFor(IQueryHit queryHit);
public abstract Element createQueryHitElement(IQueryHit queryHit, Document doc, Element parent);
public abstract boolean canReadQueryHit(Node node);
public abstract void readQueryHit(Node node, TaskList tlist, IRepositoryQuery query)
throws TaskListExternalizerException;
}
|
