Android Open Source - android-core Library Descriptor Reader

• Back to Map/object  ↑

From Project

Back to project page android-core.

License

The source code is released under:

Apache License

Java Source Code

/** 
 * [SIMINOV FRAMEWORK]// ww w . ja v  a 2s . c  o m
 * Copyright [2015] [Siminov Software Solution LLP|support@siminov.com]
 *
 * Licensed 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 siminov.core.reader;

import java.io.File;
import java.io.InputStream;
import java.util.Iterator;

import org.xml.sax.Attributes;
import org.xml.sax.SAXException;

import siminov.core.Constants;
import siminov.core.exception.DeploymentException;
import siminov.core.log.Log;
import siminov.core.model.LibraryDescriptor;


/**
 * Exposes methods to parse Library Descriptor information as per define in LibraryDescriptor.si.xml file by application.
  <p>
    <pre>
    
Example:
  {@code
    
  <library-descriptor>
  
      <!-- General Properties Of Library -->
      
      <!-- Mandatory Field -->
    <property name="name">name_of_library</property>
    
    <!-- Optional Field -->
    <property name="description">description_of_library</property>
  
    
    
    <!-- Database Mappings Needed Under This Library Descriptor -->
    
    <!-- Optional Field -->
      <!-- Database Mapping Descriptors -->
    <database-mapping-descriptors>
      <database-mapping-descriptor>name_of_database_descriptor.full_path_of_database_mapping_descriptor_file</database-mapping-descriptor>
    </database-mapping-descriptors>
     
  </library-descriptor>

  }
  
    </pre>
  </p>
 *
 */
public class LibraryDescriptorReader extends SiminovSAXDefaultHandler implements Constants {

  private String libraryName = null;

  private LibraryDescriptor libraryDescriptor = null;
  
  private StringBuilder tempValue = new StringBuilder();
  private String propertyName = null;
  
  
  /**
   * LibraryDescriptorReader Constructor
   * @param libraryName Name of the library
   */
  public LibraryDescriptorReader(final String libraryName) {

    if(libraryName == null || libraryName.length() <= 0) {
      Log.error(getClass().getName(), "Constructor", "Invalid Library Name Found.");
      throw new DeploymentException(getClass().getName(), "Constructor", "Invalid Library Name Found.");
    }
    
    this.libraryName = libraryName;
    this.libraryName = this.libraryName.replace(".", "/");
    

    InputStream libraryDescriptorStream = null;
    libraryDescriptorStream = getClass().getClassLoader().getResourceAsStream(this.libraryName + File.separator + Constants.LIBRARY_DESCRIPTOR_FILE_NAME);

    if(libraryDescriptorStream == null) {
      Log.error(getClass().getName(), "Constructor", "Invalid Library Descriptor Stream Found, LIBRARY-NAME: " + this.libraryName + File.separator + Constants.LIBRARY_DESCRIPTOR_FILE_NAME);
      throw new DeploymentException(getClass().getName(), "Constructor", "Invalid Library Descriptor Stream Found, LIBRARY-NAME: " + this.libraryName + File.separator + Constants.LIBRARY_DESCRIPTOR_FILE_NAME);
    }
    
    try {
      parseMessage(libraryDescriptorStream);
    } catch(Exception exception) {
      Log.error(getClass().getName(), "Constructor", "Exception caught while parsing LIBRARY-DESCRIPTOR: " + this.libraryName + ", " + exception.getMessage());
      throw new DeploymentException(getClass().getName(), "Constructor", "Exception caught while parsing LIBRARY-DESCRIPTOR: " + this.libraryName + ", " + exception.getMessage());
    }
    
    doValidation();
  }
  
  public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException {
    
    tempValue = new StringBuilder();

    if(localName.equalsIgnoreCase(LIBRARY_DESCRIPTOR_LIBRARY_DESCRIPTOR)) {
      libraryDescriptor = new LibraryDescriptor();
    } else if(localName.equalsIgnoreCase(LIBRARY_DESCRIPTOR_PROPERTY)) {
      initializeProperty(attributes);
    } 
  }
  
  public void characters(char[] ch, int start, int length) throws SAXException {
    String value = new String(ch,start,length);
    
    if(value == null || value.length() <= 0 || value.equalsIgnoreCase(NEW_LINE)) {
      return;
    }
    
    value = value.trim();
    tempValue.append(value);
  }

  public void endElement(String uri, String localName, String qName) throws SAXException {
    
    if(localName.equalsIgnoreCase(LIBRARY_DESCRIPTOR_PROPERTY)) {
      libraryDescriptor.addProperty(propertyName, tempValue.toString());
    } else if(localName.equalsIgnoreCase(LIBRARY_DESCRIPTOR_DATABASE_MAPPING_DESCRIPTOR)) {
      libraryDescriptor.addDatabaseMappingPath(tempValue.toString());
    }
  }
  
  private void initializeProperty(final Attributes attributes) {
    propertyName = attributes.getValue(LIBRARY_DESCRIPTOR_NAME);
  }
  
  private void doValidation() throws DeploymentException {
    
    /*
     * Validation for name field.
     */
    String name = libraryDescriptor.getName();
    if(name == null || name.length() <= 0) {
      Log.error(getClass().getName(), "doValidation", "LIBRARY-NAME IS MANDATORY FIELD - LIBRARY-DESCRIPTOR: " + this.libraryName);
      throw new DeploymentException(getClass().getName(), "doValidation", "LIBRARY-NAME IS MANDATORY FIELD - LIBRARY-DESCRIPTOR: " + this.libraryName);
    }
    
    Iterator<String> databaseMappingPaths = libraryDescriptor.getDatabaseMappingPaths();
    while(databaseMappingPaths.hasNext()) {
      String databaseMappingPath = databaseMappingPaths.next();
      
      if(databaseMappingPath.endsWith(XML_FILE_EXTENSION)) {
        if(!databaseMappingPath.contains(SIMINOV_DESCRIPTOR_EXTENSION)) {
          Log.error(getClass().getName(), "doValidation", "INVALID LIBRARY DATABASE MAPPING PATH FOUND, it should contain .core extension in path, PATH-DEFINED: " + databaseMappingPath);
          throw new DeploymentException(getClass().getName(), "doValidation", "INVALID LIBRARY DATABASE MAPPING PATH FOUND, it should contain .core extension in path, PATH-DEFINED: " + databaseMappingPath);
        }
      }
    }

  }

  /**
   * Get library descriptor object.
   * @return Library Descriptor Object.
   */
  public LibraryDescriptor getLibraryDescriptor() {
    return this.libraryDescriptor;
  }

}

Java Source Code List

• Back to Map/object  ↑