Description
The current parser and serializer APIs have several inconsistencies and naming conventions that need to be addressed for a coherent and professional API design.
Identified Inconsistencies
1. Factory Naming Inconsistency
- Parser Factory:
ParserFactory (generic name)
- Serializer Factory:
DefaultSerializerFactory (implementation-specific name)
- Issue: Inconsistent naming convention between parser and serializer factories
- Recommendation: Rename to
ParserFactory and SerializerFactory
2. File and Format Naming Coherence
- Current state: Mixed naming conventions across different formats
- Issues:
- Some formats use full names (e.g., "NTriples") while others use abbreviations
- Inconsistent casing in some areas
- File extensions not always clearly mapped to format names
- Recommendation: Establish consistent naming convention for all formats
3. Exception Handling Inconsistencies
- Current state: Mixed exception types across parser and serializer implementations
- Issues:
- Different exception hierarchies between parsers and serializers
- Inconsistent error messages and error handling patterns
- Some components use generic exceptions while others use specific ones
- Recommendation: Unify exception handling with consistent hierarchy and messages
4. Option Naming Consistency
- Current state: Inconsistent naming for configuration options across formats
- Issues:
- Some formats use
TitaniumRDFDatasetSerializationAdapter while others use different naming conventions FormatOption.
- Recommendation: Standardize option naming conventions across all formats for clarity and ease of use
Description
The current parser and serializer APIs have several inconsistencies and naming conventions that need to be addressed for a coherent and professional API design.
Identified Inconsistencies
1. Factory Naming Inconsistency
ParserFactory(generic name)DefaultSerializerFactory(implementation-specific name)ParserFactoryandSerializerFactory2. File and Format Naming Coherence
3. Exception Handling Inconsistencies
4. Option Naming Consistency
TitaniumRDFDatasetSerializationAdapterwhile others use different naming conventionsFormatOption.