AbstractXDIReader (xdi2-core 0.7.2 API)

java.lang.Object
- xdi2.core.io.AbstractXDIReader

All Implemented Interfaces:

Serializable, XDIReader

Direct Known Subclasses:

AutoReader, XDIDisplayReader, XDIJSONQuadReader, XDIJSONReader, XDIRawJSONReader
```
public abstract class AbstractXDIReader
extends Object
implements XDIReader
```
If you extend this class, you only have to implement read(Graph, Reader, Properties)

Author:

markus

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String DEFAULT_CHARSET_NAME

protected Properties parameters

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_CHARSET_NAME`
`protected Properties`	`parameters`

Constructor Summary

Constructors
Constructor and Description

AbstractXDIReader(Properties parameters)

Constructors
Constructor and Description
`AbstractXDIReader(Properties parameters)`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getFileExtension()` Returns the file extension of this XDIReader, e.g.
`String`	`getFormat()` Returns the format this XDIReader can read, e.g.
`MimeType`	`getMimeType()` Returns the mime type this XDIReader can read, e.g.
`protected abstract void`	`init()`
`InputStream`	`read(Graph graph, InputStream stream)` Reads an XDI graph from a byte stream.
`boolean`	`supportsFileExtension(String fileExtension)` Checks if a given file extension is supported.
`boolean`	`supportsFormat(String format)` Checks if a given format is supported.
`boolean`	`supportsMimeType(MimeType mimeType)` Checks if a given mime type is supported.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface xdi2.core.io.XDIReader
read

- Field Detail
  - DEFAULT_CHARSET_NAME
```
public static final String DEFAULT_CHARSET_NAME
```
    See Also:
    Constant Field Values
  - parameters
```
protected Properties parameters
```
- Constructor Detail
  - AbstractXDIReader
```
public AbstractXDIReader(Properties parameters)
```
- Method Detail
  - init
```
protected abstract void init()
```
  - read
```
public InputStream read(Graph graph,
               InputStream stream)
                 throws IOException,
                        Xdi2ParseException
```
    Description copied from interface: XDIReader
    
    Reads an XDI graph from a byte stream.
    
    Specified by:
    
    read in interface XDIReader
    
    Parameters:
    graph - A graph that will hold the read data.
    stream - A byte stream from which to read.
    
    Returns:
    The byte stream.
    
    Throws:
    
    IOException
    
    Xdi2ParseException
  - getFormat
```
public final String getFormat()
```
    Description copied from interface: XDIReader
    Returns the format this XDIReader can read, e.g.
    - XDI/JSON
    - XDI DISPLAY
    Specified by:
    
    getFormat in interface XDIReader
    
    Returns:
    The format of this XDIReader.
  - getFileExtension
```
public final String getFileExtension()
```
    Description copied from interface: XDIReader
    Returns the file extension of this XDIReader, e.g.
    - .xdi
    - .json
    Specified by:
    
    getFileExtension in interface XDIReader
    
    Returns:
    The file extension of this XDIReader.
  - getMimeType
```
public final MimeType getMimeType()
```
    Description copied from interface: XDIReader
    Returns the mime type this XDIReader can read, e.g.
    - text/plain
    - application/xdi+json
    Specified by:
    
    getMimeType in interface XDIReader
    
    Returns:
    The mime type of this XDIReader.
  - supportsFormat
```
public boolean supportsFormat(String format)
```
    Description copied from interface: XDIReader
    
    Checks if a given format is supported.
    
    Specified by:
    
    supportsFormat in interface XDIReader
    
    Returns:
    True, if supported.
  - supportsFileExtension
```
public boolean supportsFileExtension(String fileExtension)
```
    Description copied from interface: XDIReader
    
    Checks if a given file extension is supported.
    
    Specified by:
    
    supportsFileExtension in interface XDIReader
    
    Returns:
    True, if supported.
  - supportsMimeType
```
public boolean supportsMimeType(MimeType mimeType)
```
    Description copied from interface: XDIReader
    
    Checks if a given mime type is supported.
    
    Specified by:
    
    supportsMimeType in interface XDIReader
    
    Returns:
    True, if supported.

Class AbstractXDIReader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface xdi2.core.io.XDIReader

Field Detail

DEFAULT_CHARSET_NAME

parameters

Constructor Detail

AbstractXDIReader

Method Detail

init

read

getFormat

getFileExtension

getMimeType

supportsFormat

supportsFileExtension

supportsMimeType