Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
package org.apache.marmotta.platform.core.api.content;
API for plugins that can read content from some source. All implementing classes must provide the getContentData method that returns the byte content for a resource.

User: Sebastian Schaffert

public interface ContentReader {

    
Return the name of the content reader. Used to identify and display the content reader to admin users.

Returns:
    public String getName();

    
Retrieve the content of the specified mime type for the specified resource. Returns a byte array containing the byte data of the content, or null, indicating that a content of the specified mime type does not exist for the resource.

Specialised content readers could even transform the resource content from its original form to the new mimetype, e.g. converting an image from JPEG to PNG.

Parameters:
resource the resource for which to return the content
mimetype the mime type to retrieve of the content
Returns:
a byte array containing the content of the resource, or null if no content exists
    public byte[] getContentData(Resource resourceString mimetypethrows IOException;


    
Retrieve the content of the specified mime type for the specified resource. Returns a input stream containing the byte data of the content, or null, indicating that a content of the specified mime type does not exist for the resource.

Specialised content readers could even transform the resource content from its original form to the new mimetype, e.g. converting an image from JPEG to PNG.

This method is preferrable for resources with large amounts of data.

Parameters:
resource the resource for which to return the content
mimetype the mime type to retrieve of the content
Returns:
a InputStream containing the content of the resource, or null if no content exists
    public InputStream getContentStream(Resource resourceString mimetypethrows IOException;


    
Check whether the specified resource has content of the specified mimetype for this reader. Returns true in this case, false otherwise.

Parameters:
resource the resource to check
mimetype the mimetype to look for
Returns:
true if content of this mimetype is associated with the resource, false otherwise
    public boolean hasContent(Resource resourceString mimetype);


    
Return the MIME content type of the resource passed as argument.

Parameters:
resource resource for which to return the content type
Returns:
the MIME content type of the resource
    public String getContentType(Resource resource);


    
Return the number of bytes the content of this resource contains.

Parameters:
resource resource for which to return the content length
Returns:
byte count for the resource content
    public long getContentLength(Resource resourceString mimetype);
New to GrepCode? Check out our FAQ X