156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson/* 256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Copyright (C) 2010 Google Inc. 356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * 456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Licensed under the Apache License, Version 2.0 (the "License"); 556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * you may not use this file except in compliance with the License. 656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * You may obtain a copy of the License at 756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * 856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * http://www.apache.org/licenses/LICENSE-2.0 956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * 1056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Unless required by applicable law or agreed to in writing, software 1156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * distributed under the License is distributed on an "AS IS" BASIS, 1256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * See the License for the specific language governing permissions and 1456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * limitations under the License. 1556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson */ 1656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 1756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonpackage org.clearsilver; 1856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 1956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport java.io.FileNotFoundException; 2056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport java.io.IOException; 2156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport java.util.Date; 2256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport java.util.TimeZone; 2356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 2456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson/** 2556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Utility class that delegates all methods of an HDF object. Made to 2656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * facilitate the transition to HDF being an interface and thus not 2756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * extensible in the same way as it was. 2856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * <p> 2956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * This class, and its subclasses must take care to wrap or unwrap HDF and CS 3056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * objects as they are passed through from the callers to the delegate object. 3156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson */ 3256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonpublic abstract class DelegatedHdf implements HDF { 3356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 3456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson private final HDF hdf; 3556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 3656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public DelegatedHdf(HDF hdf) { 3756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson if (hdf == null) { 3856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson throw new NullPointerException("Null HDF is not allowed in constructor of DelegatedHdf."); 3956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 4056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson this.hdf = hdf; 4156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 4256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 4356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson /** 4456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Utility function for concrete ClearsilverFactories to unwrap DelegatedHdfs 4556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * and get down to a concrete (or unknown) HDF object. 4656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * @param hdf the possibly DelegatedHdf to unwrap 4756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * @return the innermost non-DelegatedHdf HDF object. 4856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson */ 4956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public static HDF getFullyUnwrappedHdf(HDF hdf) { 5056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson while (hdf instanceof DelegatedHdf) { 5156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson hdf = ((DelegatedHdf)hdf).getHdf(); 5256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 5356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return hdf; 5456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 5556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 5656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public HDF getHdf() { 5756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return hdf; 5856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 5956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 6056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson /** 6156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Method subclasses are required to override with a method that returns a 6256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * new DelegatedHdf object that wraps the specified HDF object. 6356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * 6456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * @param hdf an HDF object that should be wrapped in a new DelegatedHdf 6556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * object of the same type as this current object. 6656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * @return an object that is a subclass of DelegatedHdf and which wraps the 6756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * given HDF object. 6856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson */ 6956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson protected abstract DelegatedHdf newDelegatedHdf(HDF hdf); 7056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 7156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public void close() { 7256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson getHdf().close(); 7356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 7456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 7556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public boolean readFile(String filename) throws IOException, FileNotFoundException { 7656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return getHdf().readFile(filename); 7756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 7856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 7956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public CSFileLoader getFileLoader() { 8056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return getHdf().getFileLoader(); 8156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 8256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 8356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public void setFileLoader(CSFileLoader fileLoader) { 8456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson getHdf().setFileLoader(fileLoader); 8556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 8656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 8756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public boolean writeFile(String filename) throws IOException { 8856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return getHdf().writeFile(filename); 8956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 9056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 9156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public boolean readString(String data) { 9256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return getHdf().readString(data); 9356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 9456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 9556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public String writeString() { 9656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return getHdf().writeString(); 9756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 9856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 9956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public int getIntValue(String hdfname, 10056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson int default_value) { 10156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return getHdf().getIntValue(hdfname, default_value); 10256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 10356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 10456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public String getValue(String hdfname, String default_value) { 10556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return getHdf().getValue(hdfname, default_value); 10656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 10756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 10856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public void setValue( 10956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson String hdfname, String value) { 11056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson getHdf().setValue(hdfname, value); 11156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 11256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 11356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public void removeTree(String hdfname) { 11456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson getHdf().removeTree(hdfname); 11556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 11656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 11756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public void setSymLink(String hdf_name_src, 11856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson String hdf_name_dest) { 11956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson getHdf().setSymLink(hdf_name_src, hdf_name_dest); 12056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 12156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 12256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public void exportDate( 12356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson String hdfname, TimeZone timeZone, Date date) { 12456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson getHdf().exportDate(hdfname, timeZone, date); 12556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 12656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 12756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public void exportDate( 12856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson String hdfname, String tz, int tt) { 12956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson getHdf().exportDate(hdfname, tz, tt); 13056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 13156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 13256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public DelegatedHdf getObj(String hdfpath) { 13356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson HDF hdf = getHdf().getObj(hdfpath); 13456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return hdf != null ? newDelegatedHdf(hdf) : null; 13556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 13656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 13756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public DelegatedHdf getChild(String hdfpath) { 13856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson HDF hdf = getHdf().getChild(hdfpath); 13956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return hdf != null ? newDelegatedHdf(hdf) : null; 14056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 14156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 14256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public DelegatedHdf getRootObj() { 14356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson HDF hdf = getHdf().getRootObj(); 14456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return hdf != null ? newDelegatedHdf(hdf) : null; 14556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 14656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 14756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public boolean belongsToSameRoot(HDF hdf) { 14856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return getFullyUnwrappedHdf(this).belongsToSameRoot(getFullyUnwrappedHdf(hdf)); 14956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 15056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 15156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public DelegatedHdf getOrCreateObj(String hdfpath) { 15256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson HDF hdf = getHdf().getOrCreateObj(hdfpath); 15356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return hdf != null ? newDelegatedHdf(hdf) : null; 15456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 15556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 15656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public String objName() { 15756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return getHdf().objName(); 15856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 15956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 16056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public String objValue() { 16156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return getHdf().objValue(); 16256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 16356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 16456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public DelegatedHdf objChild() { 16556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson HDF hdf = getHdf().objChild(); 16656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return hdf != null ? newDelegatedHdf(hdf) : null; 16756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 16856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 16956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public DelegatedHdf objNext() { 17056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson HDF hdf = getHdf().objNext(); 17156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return hdf != null ? newDelegatedHdf(hdf) : null; 17256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 17356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 17456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public void copy(String hdfpath, HDF src) { 17556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson if (src != null && src instanceof DelegatedHdf) { 17656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson src = ((DelegatedHdf)src).getHdf(); 17756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 17856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson getHdf().copy(hdfpath, src); 17956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 18056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 18156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public String dump() { 18256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return getHdf().dump(); 18356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 18456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson} 18556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 186