Skip to content

Commit 9f4fe2a

Browse files
author
Miel Vander Sande
committed
Cleanup and finished interface renaming
1 parent 541c48f commit 9f4fe2a

20 files changed

+75
-66
lines changed

src/org/linkeddatafragments/datasource/AbstractRequestProcessor.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
package org.linkeddatafragments.datasource;
22

33
import org.linkeddatafragments.fragments.ILinkedDataFragment;
4-
import org.linkeddatafragments.fragments.LinkedDataFragmentRequest;
4+
import org.linkeddatafragments.fragments.ILinkedDataFragmentRequest;
55

66
/**
77
* Base class for implementations of {@link IFragmentRequestProcessor}.
@@ -16,22 +16,22 @@ public void close() {}
1616

1717
@Override
1818
final public ILinkedDataFragment createRequestedFragment(
19-
final LinkedDataFragmentRequest request )
19+
final ILinkedDataFragmentRequest request )
2020
throws IllegalArgumentException
2121
{
2222
return getWorker( request ).createRequestedFragment();
2323
}
2424

2525
abstract protected Worker getWorker(
26-
final LinkedDataFragmentRequest request )
26+
final ILinkedDataFragmentRequest request )
2727
throws IllegalArgumentException;
2828

2929

3030
abstract static protected class Worker
3131
{
32-
public final LinkedDataFragmentRequest request;
32+
public final ILinkedDataFragmentRequest request;
3333

34-
public Worker( final LinkedDataFragmentRequest request )
34+
public Worker( final ILinkedDataFragmentRequest request )
3535
{
3636
this.request = request;
3737
}

src/org/linkeddatafragments/datasource/AbstractRequestProcessorForTriplePatterns.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
import com.hp.hpl.jena.rdf.model.Model;
44

55
import org.linkeddatafragments.fragments.ILinkedDataFragment;
6-
import org.linkeddatafragments.fragments.LinkedDataFragmentRequest;
6+
import org.linkeddatafragments.fragments.ILinkedDataFragmentRequest;
77
import org.linkeddatafragments.fragments.tpf.ITriplePatternElement;
88
import org.linkeddatafragments.fragments.tpf.ITriplePatternFragment;
99
import org.linkeddatafragments.fragments.tpf.TriplePatternFragmentImpl;
@@ -30,7 +30,7 @@
3030
{
3131
@Override
3232
protected final Worker<CTT,NVT,AVT> getWorker(
33-
final LinkedDataFragmentRequest request )
33+
final ILinkedDataFragmentRequest request )
3434
throws IllegalArgumentException
3535
{
3636
if ( request instanceof ITriplePatternFragmentRequest<?,?,?> ) {
@@ -61,7 +61,7 @@ public Worker(
6161
public ILinkedDataFragment createRequestedFragment()
6262
throws IllegalArgumentException
6363
{
64-
final long limit = LinkedDataFragmentRequest.TRIPLESPERPAGE;
64+
final long limit = ILinkedDataFragmentRequest.TRIPLESPERPAGE;
6565
final long offset;
6666
if ( request.isPageRequest() )
6767
offset = limit * ( request.getPageNumber() - 1L );

src/org/linkeddatafragments/datasource/DataSourceFactory.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
package org.linkeddatafragments.datasource;
22

33
import com.google.gson.JsonObject;
4-
import org.linkeddatafragments.exceptions.DataSourceException;
4+
import org.linkeddatafragments.exceptions.DataSourceCreationException;
55
import org.linkeddatafragments.exceptions.UnknownDataSourceTypeException;
66

77
/**
@@ -16,9 +16,9 @@ public class DataSourceFactory {
1616
*
1717
* @param config
1818
* @return datasource interface
19-
* @throws DataSourceException
19+
* @throws DataSourceCreationException
2020
*/
21-
public static IDataSource create(JsonObject config) throws DataSourceException {
21+
public static IDataSource create(JsonObject config) throws DataSourceCreationException {
2222
String title = config.getAsJsonPrimitive("title").getAsString();
2323
String description = config.getAsJsonPrimitive("description").getAsString();
2424
String typeName = config.getAsJsonPrimitive("type").getAsString();

src/org/linkeddatafragments/datasource/IDataSourceType.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
package org.linkeddatafragments.datasource;
22

3-
import org.linkeddatafragments.exceptions.DataSourceException;
3+
import org.linkeddatafragments.exceptions.DataSourceCreationException;
44

55
import com.google.gson.JsonObject;
66

@@ -28,5 +28,5 @@ public interface IDataSourceType
2828
IDataSource createDataSource( final String title,
2929
final String description,
3030
final JsonObject settings )
31-
throws DataSourceException;
31+
throws DataSourceCreationException;
3232
}

src/org/linkeddatafragments/datasource/IFragmentRequestProcessor.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@
44

55
import org.linkeddatafragments.fragments.ILinkedDataFragment;
66
import org.linkeddatafragments.fragments.ILinkedDataFragment;
7-
import org.linkeddatafragments.fragments.LinkedDataFragmentRequest;
8-
import org.linkeddatafragments.fragments.LinkedDataFragmentRequest;
7+
import org.linkeddatafragments.fragments.ILinkedDataFragmentRequest;
8+
import org.linkeddatafragments.fragments.ILinkedDataFragmentRequest;
99

1010
/**
11-
* Processes {@link LinkedDataFragmentRequest}s and returns
11+
* Processes {@link ILinkedDataFragmentRequest}s and returns
1212
* the requested {@link ILinkedDataFragment}s.
1313
*
1414
* @author <a href="http://olafhartig.de">Olaf Hartig</a>
1515
*/
1616
public interface IFragmentRequestProcessor extends Closeable
1717
{
1818
ILinkedDataFragment createRequestedFragment(
19-
final LinkedDataFragmentRequest request )
19+
final ILinkedDataFragmentRequest request )
2020
throws IllegalArgumentException;
2121
}

src/org/linkeddatafragments/datasource/hdt/HdtDataSourceType.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
import org.linkeddatafragments.datasource.IDataSource;
77
import org.linkeddatafragments.datasource.IDataSourceType;
8-
import org.linkeddatafragments.exceptions.DataSourceException;
8+
import org.linkeddatafragments.exceptions.DataSourceCreationException;
99

1010
import com.google.gson.JsonObject;
1111

@@ -20,15 +20,15 @@ public class HdtDataSourceType implements IDataSourceType
2020
public IDataSource createDataSource( final String title,
2121
final String description,
2222
final JsonObject settings )
23-
throws DataSourceException
23+
throws DataSourceCreationException
2424
{
2525
final String fname = settings.getAsJsonPrimitive("file").getAsString();
2626
final File file = new File( fname );
2727

2828
try {
2929
return new HdtDataSource(title, description, file.getAbsolutePath());
3030
} catch (IOException ex) {
31-
throw new DataSourceException(ex);
31+
throw new DataSourceCreationException(ex);
3232
}
3333
}
3434

src/org/linkeddatafragments/datasource/tdb/JenaTDBDataSourceType.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
import org.linkeddatafragments.datasource.IDataSource;
66
import org.linkeddatafragments.datasource.IDataSourceType;
7-
import org.linkeddatafragments.exceptions.DataSourceException;
7+
import org.linkeddatafragments.exceptions.DataSourceCreationException;
88

99
import com.google.gson.JsonObject;
1010

@@ -20,15 +20,15 @@ public class JenaTDBDataSourceType implements IDataSourceType
2020
public IDataSource createDataSource( final String title,
2121
final String description,
2222
final JsonObject settings )
23-
throws DataSourceException
23+
throws DataSourceCreationException
2424
{
2525
final String dname = settings.getAsJsonPrimitive("directory").getAsString();
2626
final File dir = new File( dname );
2727

2828
try {
2929
return new JenaTDBDataSource(title, description, dir);
3030
} catch (Exception ex) {
31-
throw new DataSourceException(ex);
31+
throw new DataSourceCreationException(ex);
3232
}
3333
}
3434

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
package org.linkeddatafragments.exceptions;
2+
3+
/**
4+
*
5+
* @author mielvandersande
6+
*/
7+
public class DataSourceCreationException extends DataSourceException {
8+
9+
public DataSourceCreationException(Throwable cause) {
10+
super(cause);
11+
}
12+
13+
public DataSourceCreationException(String datasourceName, String message) {
14+
super(datasourceName, "Could not create DataSource - " + message);
15+
}
16+
}
Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,23 @@
11
package org.linkeddatafragments.exceptions;
22

3+
import org.linkeddatafragments.datasource.IDataSource;
4+
35
/**
46
*
57
* @author mielvandersande
68
*/
7-
public class DataSourceException extends Exception {
8-
private static final long serialVersionUID = 1L;
9+
abstract public class DataSourceException extends Exception {
910

1011
public DataSourceException(Throwable cause) {
11-
super(cause.getMessage());
12+
super(cause);
1213
}
1314

14-
public DataSourceException(String message) {
15-
super("Could not create DataSource: " + message);
16-
}
15+
public DataSourceException(String datasourceName, String message) {
16+
super("Error for datasource '" + datasourceName + "': " + message);
17+
}
18+
19+
public DataSourceException(IDataSource datasource, String message) {
20+
this(datasource.getTitle(), message);
21+
}
22+
1723
}
Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,12 @@
11
package org.linkeddatafragments.exceptions;
22

3-
import org.linkeddatafragments.datasource.IDataSource;
4-
53
/**
64
*
75
* @author mielvandersande
86
*/
9-
public class DataSourceNotFoundException extends Exception {
10-
private static final long serialVersionUID = 1L;
11-
12-
public DataSourceNotFoundException(Throwable cause) {
13-
super(cause.getMessage());
14-
}
7+
public class DataSourceNotFoundException extends DataSourceException {
158

169
public DataSourceNotFoundException(String dataSourceName) {
17-
super("Data source " + dataSourceName + " not found.");
10+
super(dataSourceName, "Datasource not found.");
1811
}
1912
}

src/org/linkeddatafragments/exceptions/UnknownDataSourceTypeException.java

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,9 @@
44
*
55
* @author mielvandersande
66
*/
7-
public class UnknownDataSourceTypeException extends DataSourceException {
8-
private static final long serialVersionUID = 1L;
9-
7+
public class UnknownDataSourceTypeException extends DataSourceCreationException {
8+
109
public UnknownDataSourceTypeException(String type) {
11-
super("Type " + type + " does not exist.");
10+
super("", "Type " + type + " does not exist.");
1211
}
1312
}

src/org/linkeddatafragments/fragments/FragmentRequestParserBase.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
abstract public class FragmentRequestParserBase implements IFragmentRequestParser
1313
{
1414
@Override
15-
final public LinkedDataFragmentRequest parseIntoFragmentRequest(
15+
final public ILinkedDataFragmentRequest parseIntoFragmentRequest(
1616
final HttpServletRequest httpRequest,
1717
final ConfigReader config )
1818
throws IllegalArgumentException
@@ -40,7 +40,7 @@ public Worker( final HttpServletRequest request,
4040
this.config = config;
4141

4242
final String givenPageNumber = request.getParameter(
43-
LinkedDataFragmentRequest.PARAMETERNAME_PAGE );
43+
ILinkedDataFragmentRequest.PARAMETERNAME_PAGE );
4444
if ( givenPageNumber != null ) {
4545
long pageNumber;
4646
try {
@@ -57,7 +57,7 @@ public Worker( final HttpServletRequest request,
5757
}
5858
}
5959

60-
abstract public LinkedDataFragmentRequest createFragmentRequest()
60+
abstract public ILinkedDataFragmentRequest createFragmentRequest()
6161
throws IllegalArgumentException;
6262

6363
public String getFragmentURL() {

src/org/linkeddatafragments/fragments/IFragmentRequestParser.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,21 @@
55
import org.linkeddatafragments.config.ConfigReader;
66

77
/**
8-
* Parses HTTP requests into specific {@link LinkedDataFragmentRequest}s.
8+
* Parses HTTP requests into specific {@link ILinkedDataFragmentRequest}s.
99
*
1010
* @author <a href="http://olafhartig.de">Olaf Hartig</a>
1111
*/
1212
public interface IFragmentRequestParser
1313
{
1414
/**
1515
* Parses the given HTTP request into a specific
16-
* {@link LinkedDataFragmentRequest}.
16+
* {@link ILinkedDataFragmentRequest}.
1717
*
1818
* @throws IllegalArgumentException
1919
* If the given HTTP request cannot be interpreted (perhaps due to
2020
* missing request parameters).
2121
*/
22-
LinkedDataFragmentRequest parseIntoFragmentRequest(
22+
ILinkedDataFragmentRequest parseIntoFragmentRequest(
2323
final HttpServletRequest httpRequest,
2424
final ConfigReader config )
2525
throws IllegalArgumentException;

src/org/linkeddatafragments/fragments/LinkedDataFragmentRequest.java renamed to src/org/linkeddatafragments/fragments/ILinkedDataFragmentRequest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
*
66
* @author <a href="http://olafhartig.de">Olaf Hartig</a>
77
*/
8-
public interface LinkedDataFragmentRequest
8+
public interface ILinkedDataFragmentRequest
99
{
1010
public final static long TRIPLESPERPAGE = 100L;
1111
public final static String PARAMETERNAME_PAGE = "page";

src/org/linkeddatafragments/fragments/LinkedDataFragmentBase.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ public boolean isLastPage() {
5151

5252
@Override
5353
public long getMaxPageSize() {
54-
return LinkedDataFragmentRequest.TRIPLESPERPAGE;
54+
return ILinkedDataFragmentRequest.TRIPLESPERPAGE;
5555
}
5656

5757
/**
@@ -113,7 +113,7 @@ public void addControls( final Model model )
113113

114114
final Resource firstPageId =
115115
model.createResource(
116-
pagedURL.setParameter(LinkedDataFragmentRequest.PARAMETERNAME_PAGE,
116+
pagedURL.setParameter(ILinkedDataFragmentRequest.PARAMETERNAME_PAGE,
117117
"1").toString() );
118118

119119
fragmentId.addProperty( CommonResources.HYDRA_FIRSTPAGE, firstPageId );
@@ -122,7 +122,7 @@ public void addControls( final Model model )
122122
final String prevPageNumber = Long.toString( pageNumber - 1 );
123123
final Resource prevPageId =
124124
model.createResource(
125-
pagedURL.setParameter(LinkedDataFragmentRequest.PARAMETERNAME_PAGE,
125+
pagedURL.setParameter(ILinkedDataFragmentRequest.PARAMETERNAME_PAGE,
126126
prevPageNumber).toString() );
127127

128128
fragmentId.addProperty( CommonResources.HYDRA_PREVIOUSPAGE, prevPageId );
@@ -132,7 +132,7 @@ public void addControls( final Model model )
132132
final String nextPageNumber = Long.toString( pageNumber + 1 );
133133
final Resource nextPageId =
134134
model.createResource(
135-
pagedURL.setParameter(LinkedDataFragmentRequest.PARAMETERNAME_PAGE,
135+
pagedURL.setParameter(ILinkedDataFragmentRequest.PARAMETERNAME_PAGE,
136136
nextPageNumber).toString() );
137137

138138
fragmentId.addProperty( CommonResources.HYDRA_NEXTPAGE, nextPageId );

src/org/linkeddatafragments/fragments/LinkedDataFragmentRequestBase.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
package org.linkeddatafragments.fragments;
22

33
/**
4-
* Base class for implementations of {@link LinkedDataFragmentRequest}.
4+
* Base class for implementations of {@link ILinkedDataFragmentRequest}.
55
*
66
* @author <a href="http://olafhartig.de">Olaf Hartig</a>
77
*/
88
public abstract class LinkedDataFragmentRequestBase
9-
implements LinkedDataFragmentRequest
9+
implements ILinkedDataFragmentRequest
1010
{
1111
public final String fragmentURL;
1212
public final String datasetURL;

src/org/linkeddatafragments/fragments/tpf/ITriplePatternFragmentRequest.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
package org.linkeddatafragments.fragments.tpf;
22

3-
import org.linkeddatafragments.fragments.LinkedDataFragmentRequest;
3+
import org.linkeddatafragments.fragments.ILinkedDataFragmentRequest;
44

55
/**
66
* Represents a request of a Triple Pattern Fragment (TPF).
@@ -14,7 +14,7 @@
1414
* @author <a href="http://olafhartig.de">Olaf Hartig</a>
1515
*/
1616
public interface ITriplePatternFragmentRequest<ConstantTermType,NamedVarType,AnonVarType>
17-
extends LinkedDataFragmentRequest
17+
extends ILinkedDataFragmentRequest
1818
{
1919
public final static String PARAMETERNAME_SUBJ = "subject";
2020
public final static String PARAMETERNAME_PRED = "predicate";

0 commit comments

Comments
 (0)